Zendesk is deprecating the option to authenticate via API token. Therefore, babelforce added the option to authenticate via an OAuth client. This article explains how to set it up.
Zendesk side: create the OAuth client
To register babelforce in your Zendesk account, you can follow this article or the steps described below.
-
Go to the Zendesk Admin Center → Apps and integrations → APIs → OAuth clients, then click Add OAuth client.
⚠️ Important: pick the right menu. Zendesk has two similarly named sections. Use APIs → OAuth clients (path: Apps and integrations > APIs > OAuth clients). Do not use Connections → OAuth Clients, that section (with Grant type / Authorize URL / Token URL fields) is for Zendesk connecting out to a third party and is the wrong one.
Click to add a new OAuth Client
- Enter a title and description, in the example below, we used the name "babelforce":
| Field | What to enter |
|---|---|
| Name* (required) | A name you'll recognize later, e.g. babelforce. (No spaces; letters, numbers, -, _, =, . only.) |
| Description* | Short description, e.g. "babelforce integration". |
| Company* | Your company name. |
| Logo | Optional, can be left empty. |
| Identifier* | Auto-filled from the Name. Note this value, you'll enter it as "Client ID" on the babelforce side. |
| Client kind | Confidential |
| Redirect URLs |
https://{env}.babelforce.com/oauth2/callback (replace {env} with your babelforce environment, e.g. companyname). |
| Scopes | Leave empty. |
| Secret | Click Show secret, then copy and store it securely: you need it for the babelforce setup (it's only shown once). |
Click Save!
babelforce part:
Go to Automations → Apps (Integrations), then open your existing Zendesk integration or add a new one via Add. Fill out the fields:
| Field | What to enter |
|---|---|
| Name* | A name for the integration, e.g. zendesk. |
| Label* | A display label, e.g. My custom [zendesk_v2] integration. |
| Add tag | Optional. |
| Color | Optional. |
| App Id | Your Zendesk app id (needed for Omnichannel). |
| Account domain | Your Zendesk subdomain only e.g. babeltest for babeltest.zendesk.com. |
| OAuth Scope | read write |
| Username (Legacy) | Leave empty: legacy API-token auth only. |
| API token (Legacy) | Leave empty: legacy API-token auth only. |
Then, in the Authentication section:
| Field | What to enter |
|---|---|
| Client ID | The Identifier from the Zendesk OAuth client (e.g. babelforce). |
| Client secret | Paste the secret you copied on the Zendesk side. |
Steps:
- Click Save.
- Reopen the integration and click "Authorize" (in the Authentication section): follow the authorization flow.
- To confirm you're connected, click "test" on the integrations overview page: you should see a green success message.
Note: With OAuth, you can leave Username (Legacy) and API token (Legacy) empty: those fields are only for the deprecated API-token method. Authentication happens via Client ID + Client secret + Authorize.
--> To ensure you're successfully authenticated, click "test" in the integrations overview page - you should see a green success message popping up:
Comments
0 comments
Please sign in to leave a comment.