Search guide...

                    API Documentation

                    REST API and Webhooks

                    Overview copy-icon

                    Copilot was designed platform-first which means that for most resources — clients, companies, messages, etc. — there are associated API endpoints and webhooks. These let you set up your own custom workflows and can be used in Custom Apps. Our API documentation is the best place to get started with our API.

                    Copilot API copy-icon

                    Copilot's public API is organized around REST. Our API has predicated resource-oriented URLs, accepts JSON request bodies and returns JSON-encoded responses, and uses standard HTTP response codes and verbs. You can generate your API key on the Settings > API page.

                    Webhooks copy-icon

                    Webhooks can be created on the Settings > API page.

                    Rate Limits copy-icon

                    The API is limited to 20 requests per second, 2000 requests per day. If you exceed this rate, you will receive a 429 status code. Subsequent requests will succeed after one second.

                    Frequently Asked Questions

                    How do I create my API key? copy-icon

                    To create your API key, you'll want to go to Settings > API in the Copilot Dashboard.

                    Click Create key. In the dialog, label your key.

                    Click Create key. In the next dialog, you'll see your generated key.

                    Be sure to copy the key and paste it somewhere secure on your local device - once the dialog is closed, you will not have access to copy the key again. You can always revoke the current key and create a new one, however.

                    Your API Key is needed to perform automations with Zapier, Make, or to use our API directly.

                    How can I create webhooks? copy-icon

                    If you are an admin user, you can create webhooks on the Settings > API page. 

                    To create a webhook, click New webhook in the Webhooks section. Label your webhook, paste your endpoint URL, and select which events to send to the webhook.

                    Note: Make only supports one webhook per event per scenario. If using a Make webhook for a Copilot trigger, be sure to only send the event that corresponds to the trigger.