Getting started

The Sidecar CX API is a Conversational AI API for support and lead generation services. The API is designed to allow system integrators an easy way to add Conversational AI to their applications. It is designed using REST principals with predictable resource-based URLs and fully documented request and response bodies in the JSON-encoded format. The APIS use standard HTTP response codes, verbs, and authentication.

Webhooks are utilized to communicate directly with your application to push content directly which simplifies the implementation when compared to other communication APIs which utilize long-lived HTTP connections or websockets. You will require a back-end server to implement these webhooks. Any language and framework works with the Sidecar CX webhooks.

Building an application with Sidecar CX is simple! Begin by registering a new Application in the Applications dashboard under Account Settings. You will need to be an administrator of the account to create applications. When creating your application, you will be asked to name your application and register your webhook information. It is not required at the time of registration to have your webhooks implemented on your server. Registering your application will generate an API key for use with authentication. You will want to keep this key safe and secure and not store in any publicly accessible areas such as GitHub, client-side code, mobile applications, and so-forth.