Skip to main content

Authorization

Follow this guide to create a new TalkDesk credential that will allow Nexla to authenticate to and exchange data with your TalkDesk account.
talkdesk_api_auth.png

TalkDesk

Prerequisites​

Before creating a TalkDesk credential, you need to obtain your Client ID, Client Secret, and Account Name from your TalkDesk account. TalkDesk uses OAuth2 2-legged authentication for all API requests, with credentials sent in the request to obtain an access token.

To obtain your TalkDesk credentials, follow these steps:

  1. Sign in to your TalkDesk account using your administrator credentials.

  2. Navigate to Admin in the top navigation menu, then select Integrations or navigate to Admin > Integrations.

  3. Look for the API or OAuth section in the Integrations page, or navigate to Admin > Integrations > API.

  4. If you don't have OAuth credentials yet, look for the option to create or register an OAuth application.

  5. Click Create OAuth App or Register Application to create a new OAuth application.

  6. Configure your OAuth application settings:

    • Enter a name for the application (e.g., "Nexla Integration")
    • Review and select the permissions or scopes for the application (if applicable)

  7. Click Create or Register to create the OAuth application.

  8. After the application is created, you will be provided with your Client ID and Client Secret. Copy both credentials immediately, as the Client Secret may not be accessible again after you navigate away from the page.

  9. Your Account Name is your TalkDesk account subdomain (e.g., if your TalkDesk URL is https://yourcompany.talkdeskid.com, then your Account Name is yourcompany). You can find this in your TalkDesk account URL or in your account settings.

  10. Store all credentials securely, as you will need them to configure your Nexla credential. The Client ID, Client Secret, and Account Name are sensitive information and should be kept confidential.

The OAuth2 credentials are used to obtain an access token via the 2-legged OAuth flow. The Client ID and Client Secret are sent in the OAuth token request to obtain an access token. The access token is then sent in the Authorization: Basic {token} header for all API requests to the TalkDesk API. The token authenticates your requests and grants access to TalkDesk resources based on your account permissions. If your credentials are compromised, you should immediately revoke them in your TalkDesk account settings and generate new ones. For detailed information about OAuth2 authentication, API access, and available endpoints, refer to the TalkDesk API documentation.

Create a TalkDesk Credential​

  • To create a new TalkDesk credential, after selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

New Credential Overlay – TalkDesk

TalkDeskCred.png

Credential Name & Description​

  1. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

    Resource descriptions are recommended but are not required. They should be used provide information about the resource purpose, data freshness, etc. that can help the owner and other users efficiently understand and utilize the resource.

OAuth2 2-Legged Authentication​

TalkDesk uses OAuth2 2-legged authentication for all API requests. The Client ID, Client Secret, and Account Name are used to obtain an access token, which is then sent in the Authorization header with the Basic prefix.

  1. Enter your TalkDesk Client ID in the Client ID field. This is the Client ID you obtained from your TalkDesk account settings (Admin > Integrations > API) when creating your OAuth application. The Client ID is used along with the Client Secret and Account Name to obtain an access token for API requests.

  2. Enter your TalkDesk Client Secret in the Client Secret field. This is the Client Secret you obtained from your TalkDesk account settings when creating your OAuth application. The Client Secret is used along with the Client ID and Account Name to obtain an access token for API requests. The Client Secret is sensitive information and must be kept confidential.

  3. Enter your TalkDesk Account Name in the Account Name field. This should be your TalkDesk account subdomain (e.g., if your TalkDesk URL is https://yourcompany.talkdeskid.com, then your Account Name is yourcompany). The Account Name is used to construct the OAuth token URL (e.g., https://{account_name}.talkdeskid.com/oauth/token) for obtaining access tokens.

    Your TalkDesk OAuth credentials can be found in your TalkDesk account settings under Admin > Integrations > API. The Client ID and Client Secret are generated when you create an OAuth application. The Account Name is your TalkDesk account subdomain.

    These credentials are used together to obtain an access token via the OAuth2 2-legged flow. The access token is then sent in the Authorization: Basic {token} header for all API requests to the TalkDesk API.

    If your credentials are compromised, you should immediately revoke them in your TalkDesk account settings and generate new ones. The credentials provide access to your TalkDesk account data and should be treated as sensitive information. Keep your credentials secure and do not share them publicly.

    For detailed information about OAuth2 authentication, API access, and available endpoints, see the TalkDesk API documentation.

Save the Credential​

  1. Once all of the relevant steps in the above sections have been completed, click the Save button at the bottom of the overlay to save the configured credential.

  2. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation and can be selected for use with a new data source or destination.