Zendesk connects to Caddi through an OAuth client that you create in Zendesk Admin Center.
Before you start
You'll need:
A Zendesk admin with permission to create and manage OAuth clients in Admin Center
Your Zendesk subdomain address,
https://<your-subdomain>.zendesk.com. A custom help center domain does not work.Owner or Admin access to your Caddi organization
Step 1: Create the OAuth client in Zendesk
In Zendesk Admin Center, click Apps and integrations in the sidebar, then select APIs > OAuth clients.
Click Add OAuth client.
Name —
Caddi. This is the name users see when they grant access.Identifier — filled in automatically from the name. You can leave it as is. Copy it; this is the value Caddi calls Unique Identifier.
Client kind — select Confidential.
Redirect URLs — enter
https://app.trycaddi.com/oauth-callback. The same URL is shown in the Caddi Configure form (Step 2) with a Copy redirect URL button.Scopes — optional. Zendesk allows all scopes when this is left empty.
Click Save. After the page refreshes, a Secret field appears near the bottom.
Copy the full secret. The text can run past the edge of the box, so select all of it. Zendesk shows the full secret only once.
Click Save again.
Do not send this secret by email, chat, or a support ticket. Paste it straight into Caddi in Step 2, or keep it in a password manager until you do.
Step 2: Configure Zendesk in Caddi
In Caddi, open Settings, then Integrations.
Under Connectors you can configure, find Zendesk - Custom OAuth Client and click Configure.
Zendesk Subdomain URL — your Zendesk address,
https://<your-subdomain>.zendesk.com.Unique Identifier — the Identifier you copied from the OAuth client.
Secret — the Secret you copied from the OAuth client.
OAuth Scopes — leave blank to use Caddi's default scopes.
Click Save Configuration.
Step 3: Confirm the connection
In Caddi, open Integrations in the left sidebar.
Find Zendesk - Custom OAuth Client and click Connect.
Sign in to Zendesk and approve the request. You'll be returned to Caddi with the connection active.
If you're not going to be an everyday user of Caddi, you can disconnect after confirming the connection works.
Sources
Using OAuth authentication with your application — Zendesk help
OAuth tokens for grant types — Zendesk developer docs
