App and Talkdesk Regions

Talkdesk deploys in multiple geographic locations for two reasons:

  • To provide a robust service for all our customers regardless of their place of operation.
  • To comply with restrictions on data locality driven by privacy-related legislation imposed in several countries.

Supported Regions and Base URLs

Talkdesk currently supports three regions:

If you are using Talkdesk APIs only within your Talkdesk account, you can use the hard coded region specific URLs.
However, if you are registering an app intended to be used by all Talkdesk customers, you must ensure to subscribe to the provisioning events. These events always include a _links field that contains relevant URLs concerning the event in question. Use these URLs over the hard coded ones as you operate because they already consider region specificity.

For example, to access Talkdesk APIs, the root field within _links contains a region-dependant URL (Talkdesk API Gateway). The values root may have are outlined above.

👍

Using the URLs provided within each event allows your app to work seamlessly in the defined region.

Event Payload Key Values Description (within _links)

URL KeyValue DescriptionEvents Containing the URL
rootTalkdesk API Gateway URL. The value of this URL varies according to the operating region. It is the prefix (base URL) to be used to access Talkdesk APIs.app.installed

app.updated

app.unistalled

app.trial_started

app.trial_extended

app.trial_ended

user.logout

app.credentials_rotated
userinfoProvides a URL that can be used to get information about yourself as a user, regarding an action you executed leading to the event/responseapp.installed
userProvides a URL that can be used to get information about the user that executed the action leading to the event/responseuser.logout
selfProvides more information about the requested resource (it may vary from event to event). E.g.: event name, timestamp, payload, etc.app.installed

app.updated

app.unistalled

app.trial_extended

app.trial_ended

user.logout

app.credentials_rotated
installationCan be used as an endpoint if you need more information about installation dataapp.installed

app.unistalled

app.trial_started

app.trial_extended

app.trial_ended

user.logout

app.credentials_rotated
authorizationAllows requesting and receiving an authorization code from Talkdesk that can be used to generate refresh and access tokens using the URL provided in tokensapp.installed
tokensGenerates refresh and access tokens given an authorization code or a set of client credentialsapp.installed
widget_urlA reference to a JavaScript snippet that must be included on the partner app's header. The snippet may vary if the customer is using a Talkdesk reseller, so you can't just use the hard coded snippet. You can count on the provided header to have 32px.app.installed

📘

See the Events API documentation for more information.

🚧

Troubleshooting

If you have any questions, or if you’re having any technical issues, please open a ticket using this form.