Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.
Mirrored from https://github.com/Camo67/composio.git
Synced Nov 21, 06:00 UTC
| 1 | ## How do I set up custom OAuth credentials for Zendesk? |
| 2 | |
| 3 | Use your own Zendesk OAuth client when you want users to see your app's name on the consent screen and control the credentials yourself. |
| 4 | |
| 5 | ### Create the Zendesk OAuth client |
| 6 | |
| 7 | 1. Sign in to Zendesk Admin Center at `https://<subdomain>.zendesk.com/admin/home`. |
| 8 | 2. In the sidebar, click **Apps and integrations**, then **APIs**, and open the **OAuth clients** tab. |
| 9 | 3. Click **Add OAuth client** and fill in the form: |
| 10 | - **Client Name**: for example, `Composio-Zendesk`. |
| 11 | - **Description**: optional. |
| 12 | - **Redirect URLs**: `https://backend.composio.dev/api/v1/auth-apps/add`. It must use `https`, have no trailing slash, and exactly match the `oauth_redirect_uri` field in your Composio auth config. |
| 13 | 4. Save the client and copy the **Identifier** (the client ID) and the **Secret**. |
| 14 | |
| 15 | ### Create the auth config in Composio |
| 16 | |
| 17 | 1. In the Composio dashboard, go to **Auth Configs**, click **Create Auth Config**, and select **Zendesk**. |
| 18 | |
| 19 |  |
| 20 | |
| 21 |  |
| 22 | 2. Set the authentication type to **OAuth2** and choose **Use your own developer authentication**. |
| 23 | |
| 24 |  |
| 25 | 3. Paste the client ID and secret, then click **Create Zendesk Auth Config**. |
| 26 | 4. Click **Connect Account** and enter your Zendesk subdomain, the part before `.zendesk.com` (for example `acme` in `acme.zendesk.com`). |
| 27 | 5. Approve access in Zendesk and confirm the account shows as **Active**. |
| 28 | |
| 29 | See [Custom auth configs](/docs/auth-configuration/custom-auth-configs) for the general flow. |
| 30 | |
| 31 | ### Scopes |
| 32 | |
| 33 | Zendesk has no scope settings in Admin Center. Scopes are requested during authorization from the auth config's **Scopes** field. The default auth config requests `read`, `write`, and resource scopes for organizations, tickets, users, and webhooks, such as `tickets:read` and `tickets:write`. |
| 34 | |
| 35 | The user's Zendesk role (agent, admin, and so on) still limits what the connection can do, even when broader scopes are granted. |