Get early access
In this section (13)

Keep your Zendesk scripts working

Point existing Zendesk API clients and SDKs at ChaosDesk by changing the base URL and token.

1 min read

Available on Starter, Growth, Pro, Enterprise. Compare plans

ChaosDesk answers the Zendesk API at /zd/api/v2, with Zendesk’s request and response shapes. Your own scripts and internal services usually need only a new base URL and a new token.

Switch an integration

  1. In ChaosDesk, create an API token for the integration user with Read and write access. See Create an API token.
  2. Change the base URL from https://yourcompany.zendesk.com to https://your-workspace.chaosdesk.io/zd.
  3. Authenticate as before: HTTP Basic with email/token:token, a Bearer token, or OAuth client credentials at /zd/oauth/tokens. Password sign-in is not supported.

Paths work with or without .json, like Zendesk.

What works

  • Tickets: list, show, create, update, delete, bulk update, tags, comments, audits and counts.
  • Uploads, search, users, organizations and job statuses.
  • Ticket ids: imported tickets keep their Zendesk ids, so stored references still work.
  • Help centre reading endpoints, public and read-only, for FAQ widgets on other sites.

The full list is in the Zendesk-compatible API reference.

What doesn’t

Ready-made third-party integrations hard-wired to *.zendesk.com, such as the Zapier Zendesk app, Fivetran or the Zendesk mobile SDK, can’t be pointed elsewhere. Replace them with ChaosDesk webhooks, the ChaosDesk API or the messenger.

API requests count towards your plan’s API limits.

Was this article helpful?