node.js SDK

The node.js SDK is best suited for web applications or bots. It does not support acting as WebRTC endpoint, but support starting a conference, dialing out a number or user on behalf of the logged in user, recording, etc.

Since the node.js SDK is internally using the regular JS SDK, asynchroneous eventing as also available.

The source of the examples below are on and are hosted via rawgit. When running the examples you will be asked to sign in with a Circuit sandbox account. You can register for a free account on the Circuit Portal.

The API is identical to the JS SDK.

API Documenation

Web server app to modify text messages on behalf of a user. Uses OAuth2 REST API and JavaScript SDK.

Source Demo video

Introduction example. Shows how to logon to circuit, register for events, lookup a conversation, send a message, attach files to a message, send a comment.


This sample application shows how to receive Circuit Conversation updates and how to send Circuit conversation items with the circuit node SDK.


Bot to join IRC channels from circuit.


Create conversations and messages using the circuit node SDK. Useful to load the local Circuit system for load testing.


more to come...