Improved

The API reference is now complete and kept in sync with the API

We rebuilt this reference from the API's code, and it is now published from the same repository as the API, so it changes when the API does.

  • Every endpoint now has real parameters, request bodies and responses, with examples taken from real calls. Many pages used to have only a title.
  • The sidebar is grouped by resource: Messages, Sequences, Templates, Calendar, Calls, Rules and webhooks, Salesforce and more.
  • Newly documented: the Salesforce endpoints, rules and rule actions, template and sequence folders, scheduling and unscheduling messages, meeting invites and meeting types, Q&A, and creating slash commands and enhancements.
  • Webhooks: see Rules and webhooks and Verifying webhooks for signing secrets and how to check a delivery.
  • Recently added: Calls, call recordings and transcripts, and the call webhooks (beta), and a tasks list endpoint.
  • Corrections: the rate limit is 120 requests per minute per user, and authentication uses the X-API-Token header. Old links to individual pages still work.

Something missing or wrong? Tell us at [email protected].

Psst... like working with APIs? Come join us!