Circuit Developer Community

Build amazing real-time apps using Circuit APIs.
Extend your site with video conferences, screensharing, or rich text messaging.
Create a bot to enhance the Circuit experience by integrating with third party services.

Getting started

Your application on Circuit in 3 easy steps

1. Setup your environment

  1. Start developing your app in our sandbox environment.
    If you do not have one yet, request your sandbox.
  2. In your sandbox, go to the "Administration" > "OAuth Apps" and create a new application.
    Note that if you do not see this option, enable "OAuth Apps" in "Settings" > "Circuit Labs"
  3. You are ready, launch your editor of choice.
    Happy coding ;-)

2. Build your application

  1. Read our documentation and browse our code sample application gallery to get you started with our JavaScript SDK, Node.js SDK, Rest API and the iOS SDK.
    We have a wide range of applications to help you going with the most common use cases.
  2. Check out the documentations for JS & Node.js SDK, REST API.
  3. Need some help? Reach out to the community on Stack Overflow
  4. Submit improvements, ideas or report issues directly on our project bug trackers (JS SDK, iOS SDK)
    We're happy to hear from you.
  5. Once you're done, you can go live

3. Go Live

  1. Ready for production?
    Your tenant administrator needs to register your application at "Administration" > "OAuth Apps", then give you the the API credentials.
    Note that if your administrator does not see this section, the "OAuth Apps" Labs feature needs to be enabled.
  2. Host your application on a server with SSL and fill in your production API credentials.
    You are done!
  3. If you feel like it, tell us about your app and make it publicly available.
    We'll make sure to post about it on our portal our blog.