copilot logo

Guide

copilot logo

Guide

API Documentation

REST API and Webhooks

Overview

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

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

Webhooks can be created on the Settings > API page.