const WebSocket = require("ws");
const channelName = "ChatRoomChannel";
function initializeWebSocket() {
const socket = new WebSocket("wss://app.circle.so/cable", {
headers: {
Origin: "https://your-whitelisted-domain.com",
Authorization: "Bearer HEADLESS_MEMBER_ACCESS_TOKEN"
}
});
// Handle connection open
socket.on("open", function open() {
console.log("WebSocket connection opened.");
// Subscribe to channel
const subscribeMessage = JSON.stringify({
command: "subscribe",
identifier: JSON.stringify({
channel: channelName,
community_member_id: COMMUNITY_MEMBER_ID
})
});
socket.send(subscribeMessage);
});
// Handle incoming messages
socket.on("message", function incoming(data) {
const message = JSON.parse(data);
if (message.channel === channelName) {
console.log(`Message from channel ${channelName}:`, message.data);
} else {
console.log("Message from server:", message);
}
});
// Handle errors
socket.on("error", function error(err) {
console.error("WebSocket error:", err);
});
// Handle connection close
socket.on("close", function close() {
console.log("WebSocket connection closed.");
// Optional: Implement reconnection logic here
});
return socket;
}
// Initialize the WebSocket connection
const socket = initializeWebSocket();
Welcome to the product discussion space! Here we'll share updates and gather feedback.
", "created_at": "2024-09-01T09:00:00.000Z", "updated_at": "2024-09-01T09:00:00.000Z" }, "url": "https://app.circle.so/c/product-space/welcome-to-our-product-space", "space_name": "Product Space", "space_id": 999, "user_name": "Product Manager", "comments_count": 15, "published_at": "2024-09-01T09:00:00.000Z", "likes_count": 32 }, { "id": 1002, "status": "published", "name": "New Feature Announcement", "slug": "new-feature-announcement", "body": { "id": 1002, "body": "We're excited to announce our latest feature: AI-powered recommendations!
", "created_at": "2024-09-05T14:30:00.000Z", "updated_at": "2024-09-05T14:30:00.000Z" }, "url": "https://app.circle.so/c/product-space/new-feature-announcement", "space_name": "Product Space", "space_id": 999, "user_name": "Development Lead", "comments_count": 28, "published_at": "2024-09-05T14:30:00.000Z", "likes_count": 45 }, { "id": 1003, "status": "published", "name": "Upcoming Maintenance Schedule", "slug": "upcoming-maintenance-schedule", "body": { "id": 1003, "body": "Please be aware of our upcoming maintenance window this Saturday from 2 AM to 4 AM EST.
", "created_at": "2024-09-08T11:00:00.000Z", "updated_at": "2024-09-08T11:00:00.000Z" }, "url": "https://app.circle.so/c/product-space/upcoming-maintenance-schedule", "space_name": "Product Space", "space_id": 999, "user_name": "Support Team", "comments_count": 7, "published_at": "2024-09-08T11:00:00.000Z", "likes_count": 12 } ] } ``` # Usage and limits ### API Usage Each eligible plan has an allotted number of Admin API requests, with higher-tier plans offering increased request limits. This gives you more flexibility as your needs grow. #### Plans * Business - 5,000 requests/month * Enterprise and Circle Plus - 30,000 requests/month * Circle Plus Platform - 250,000 requests/month **Note that Zapier usage does not count towards these limits.** You can monitor your usage by going to the **Developers** tab in your admin area. If you exceed your limits over the next few months, don’t worry: we won’t be enforcing our API limits until **January 1, 2025** so you have time to establish a baseline and upgrade your plan if needed. #### Rate limits To prevent attacks and/or abuses, there's a rate limiting mechanism in place on all of Circle's APIs. The limit is **2000 request per 5 minutes per IP. That number can change at any time.**\ \ It's important to note that this limit is quite generous compared to other API providers. As a best practice, when you receive a 429 (Too Many Requests) response, implement a backoff strategy by pausing your script and retrying later, ensuring that your requests are within the rate limit. ### FAQWelcome to your dashboard!