Authentication
Capacity connects to Talkdesk using an OAuth 2.0 Client Credentials grant. This is a machine-to-machine authentication flow: it issues a bearer token scoped to specific Talkdesk data resources, and doesn't require an end-user login. The same client can hold the scopes for multiple Capacity features (Calls, Chat), so most accounts only need to create one client.
The OAuth client is created in TalkDesk’s Partner Project portal — a separate tool from the main TalkDesk admin interface. You will need a TalkDesk partner account to access it. If you do not have one, contact TalkDesk support before proceeding.
Before You Begin
Before starting, confirm the following:
- You have a TalkDesk partner account with access to Partner Project. If you are unsure, log in to your TalkDesk Workspace and look for the Partner Project icon in the sidebar. If it is not present, contact TalkDesk to request access.
- You have your TalkDesk account login URL to hand — you will need the subdomain portion (Base URI) and regional domain (Region) when completing the information handover.
Configuration
The OAuth client for the CI integration is created and managed in TalkDesk’s Partner Project portal. FOllow these steps to configure authentication
Access Partner Project
Log in to your TalkDesk account via Workspace. In the left sidebar, click the Partner Project icon.
If the Partner Project icon is not visible in the sidebar, your account does not yet have partner access. Contact TalkDesk to enable it.
Create OAuth Client
Once logged in to Partner Project, click the Create OAuth client button. This opens the new client configuration form.
In the configuration form, complete the following fields:
| Field | Value |
|---|---|
| Name | Enter a descriptive name for the client, for example Capacity CI Integration. |
| Grant Type | Select Client Credentials. This is a machine-to-machine flow that does not require a user login. |
| Redirect URI | No Redirect URI is required for the Client Credentials grant type. |
Next, add the scopes for the feature(s) you're enabling:
- Enabling Calls? Add the scopes listed in the Talkdesk Calls article.
- Enabling Chat? Add the scopes listed in the Talkdesk Chat article.
- Enabling both? Add all scopes from both articles to this same client.
After configuring the name, grant type, and scopes, save the client. Talkdesk will display the generated Client ID and Client Secret — download them or copy each value manually.
The Client Secret is only displayed once. If you navigate away without saving it, you'll need to regenerate it. Store it immediately in a secure location such as a password manager or secrets vault.
Account Information
In addition to the OAuth credentials, CI requires two values that identify your specific TalkDesk environment.
Base URI
Your TalkDesk account URL follows the pattern:
https://<base-uri>.talkdeskid.com
The <base-uri> portion — everything before .talkdeskid.com — is your Base URI. For example, if your TalkDesk login URL is:
then your Base URI is mycompany.
Some TalkDesk accounts — particularly Canadian accounts — use a regional subdomain such as mycompany-ca.talkdeskidca.com. In that case the Base URI is still just the subdomain prefix (e.g. mycompany-ca) and the regional domain is captured separately in the Region field below.
Region
The Region is the TalkDesk domain that hosts your account. Common values are:
Check the URL you use when logging in to TalkDesk. The domain after the subdomain (e.g. talkdeskapp.com or talkdeskappca.com) is your Region value. If you are unsure, your TalkDesk account manager can confirm.
What to Share with Capacity
| Item | Description |
|---|---|
| Client ID | The Client ID generated in Partner Project |
| Client Secret | The Client Secret generated in Partner Project |
| Base URI | The subdomain prefix (e.g. mycompany from mycompany.talkdeskid.com) |
| Region | The TalkDesk regional domain (e.g. talkdeskapp.com) |
Always share credentials securely, never send as plain text in an emai