Establishing a Connection
Connecting to Talkdesk
To connect to Talkdesk, set the following properties:
- AccountName: The name of your Talkdesk account.
- Region: The region where your Talkdesk instance is deployed. Supported values are US (default), EU, CA, AU, UK, and FedRamp.
- OAuthClientId: The Client Id assigned when you registered your custom OAuth application.
- OAuthClientSecret: The Client Secret assigned to your custom OAuth application. See Creating a Custom OAuth Application for instructions on registering the application.
When you open the connection, the provider automatically requests an access token from Talkdesk and caches it. The token is refreshed automatically when it expires.
Authenticating to Talkdesk
Talkdesk supports the OAuth 2.0 Client Credentials grant flow. No browser-based authorization or callback URL is required.
OAuth Client Credentials
Authenticating with client credentials requires the creation of a custom OAuth application, as described in Creating a Custom OAuth Application.
To enable authentication, set these properties:
- AccountName: The name of your Talkdesk account.
- Region: The region where your Talkdesk instance is deployed. Supported values are US (default), EU, CA, AU, UK, and FedRamp.
- OAuthClientId: The Client Id assigned when you registered your OAuth application.
- OAuthClientSecret: The Client Secret assigned when you registered your OAuth application.
Use InitiateOAuth to control how the provider manages tokens:
- GETANDREFRESH (default): The provider requests a new access token on first connection and refreshes it automatically when it expires.
- REFRESH: The provider uses the token cached in OAuthSettingsLocation and refreshes it when needed. Use this setting after a prior GETANDREFRESH connection has populated the settings file.
- OFF: The provider does not request or refresh tokens. Provide a valid token via OAuthAccessToken and manage refresh yourself.
The OAuthSettingsLocation property specifies where the provider stores the cached access token. The default is OAuthSettings.txt in the current working directory. When using multiple connections with the same driver, set a distinct path for each connection to prevent one connection from overwriting another's cached token.