Developers

Build on ChaosDesk

A REST API with an OpenAPI document, a Zendesk-compatible API for the clients you already have, signed webhooks, the messenger SDK and sidebar apps.

API reference Get a token

162 REST operations
Zendesk API at /zd/api/v2
On every paid plan

Your first request

curl https://yourcompany.chaosdesk.io/api/tickets?itemsPerPage=5 \
  -H "Authorization: Bearer $CHAOSDESK_TOKEN" \
  -H "Accept: application/json"

Base URL: your workspace address. REST API under /api, Zendesk-compatible API under /zd/api/v2.

Quick start

1
Create a token
In your workspace open Admin Center, Integrations, API tokens and create a token with the read scope.
2
Call the API
Send it as a bearer token, as in the request above. Responses are JSON; collections are paginated.
3
React to changes
Add a webhook as a trigger action to get signed callbacks when tickets change.

Request limits per plan are on the rate limits page.

Explore the platform

Authentication API tokens with read or write scope, sent as a bearer token. REST API reference 162 operations across 39 resources, generated from our OpenAPI document. Zendesk-compatible API Keep your own Zendesk API clients: change the base URL and the token. Webhooks HMAC-signed deliveries with retries and a delivery log. Messenger SDK Embed the messenger, call zE(), sign visitors in with a JWT. Sidebar apps Apps built on the Zendesk App Framework v2 run in the ticket sidebar. Customer data connector Show data from your own systems next to every ticket. API changelog What changed in the API, newest first.

Client libraries

Usage and Postman collection

Generated from the same OpenAPI document as the reference. They retry rate limits, raise the API's problem details and page through collections for you.

PHPGenerated client

composer require chaosdesk/chaosdesk-php

Usage example

Node.jsGenerated client

npm install @chaosdesk/api

Usage example

PythonGenerated client

pip install chaosdesk

Usage example

REST API resources

All 39 resources