> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Talkdesk

> How to set up the Talkdesk connector, plus the actions and events that are available.

![Talkdesk](https://stackone-logos.com/api/talkdesk/filled/svg)

Betav2.3.0[See changelog](https://docs.stackone.com/connectors/talkdesk/changelog.md)

[36 actions](#actions) · [7 events](#events) · 3 auth methods

Customer Support
Ticketing

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/talkdesk/guides/connector-profile/oauth-2-0.md)
>
> Use this if everyone connecting works at your company. Requires registering an OAuth client in Talkdesk. An admin sets t...

> [card] [OAuth 2.0 (Multiple Companies) · Connector Profile](https://docs.stackone.com/connectors/talkdesk/guides/connector-profile/oauth-2-0-multiple-companies.md)
>
> Use this if you connect accounts from different companies, such as your customers. Requires registering an OAuth client...

> [card] [OAuth 2.0 (Client Credentials) · Connector Profile](https://docs.stackone.com/connectors/talkdesk/guides/connector-profile/oauth-2-0-client-credentials.md)
>
> Account-level access to your own Talkdesk instance with no user sign-in. Requires an OAuth client with the Client Creden...

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/talkdesk/guides/link-account/oauth-2-0.md)

> [card] [OAuth 2.0 (Multiple Companies) · Link Account](https://docs.stackone.com/connectors/talkdesk/guides/link-account/oauth-2-0-multiple-companies.md)

> [card] [OAuth 2.0 (Client Credentials) · Link Account](https://docs.stackone.com/connectors/talkdesk/guides/link-account/oauth-2-0-client-credentials.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Scopes

Select all
|
Clear

account:read

attributes:read

attributes:write

campaigns:read

campaigns:write

case-fields-public:read

cases-public:read

cases-public:write

contacts:read

contacts:write

data-reports:read

data-reports:write

prompts:delete

prompts:read

prompts:write

queues-users:read

queues:read

recordings:read

users:read

No scopes found

36 actions

ActionDescriptionRequired scopes

Get Account Details`talkdesk_get_account_details`

Retrieve account details for the current Talkdesk account

`account:read`

Get List Of Users`talkdesk_list_users`

List all users (agents) in the Talkdesk account

`users:read`

Get User Details`talkdesk_get_user`

Retrieve a specific user by ID

`users:read`

Get Contacts List`talkdesk_list_contacts`

List all contacts in the Talkdesk account

`contacts:read`

Get A Contact By Id`talkdesk_get_contact`

Retrieve a specific contact by ID

`contacts:read`

Delete A Contact By Id`talkdesk_delete_contact`

Delete a contact from Talkdesk

`contacts:write`

Getting A List Of Cases`talkdesk_list_cases`

List all cases in the Talkdesk account

`cases-public:read`

Getting Case Details`talkdesk_get_case`

Retrieve a specific case by ID

`cases-public:read`

Creating A Case`talkdesk_create_case`

Create a new case in Talkdesk

`cases-public:write`

Updating A Case`talkdesk_update_case`

Update an existing case in Talkdesk

`cases-public:write`

Deleting Cases Softly`talkdesk_delete_case_softly`

Soft delete cases in Talkdesk

`cases-public:write`

Getting A List Of Case Fields`talkdesk_list_of_case_fields`

Retrieve the list of available case fields

`case-fields-public:read`

List Queues`talkdesk_list_queues`

List all queues in the Talkdesk account

`queues:read`

List Queue Users`talkdesk_list_queue_users`

List all users assigned to a specific queue

`queues-users:read`

List Campaigns`talkdesk_list_campaigns`

List all campaigns in the Talkdesk account

`campaigns:read`

Get Campaign Details`talkdesk_get_campaign_details`

Retrieve a specific campaign by ID

`campaigns:read`

Create Or Duplicate Campaign`talkdesk_create_or_duplicate_campaign`

Create a new outbound calling campaign

`campaigns:write`

Update Campaign`talkdesk_update_campaign`

Update an existing campaign using JSON Patch

`campaigns:write`

Delete Campaign`talkdesk_delete_campaign`

Delete a campaign

`campaigns:write`

List Attributes`talkdesk_list_attributes`

List all routing attributes

`attributes:read`

Attribute Details`talkdesk_attribute_details`

Retrieve a specific routing attribute by ID

`attributes:read`

Create A New Attribute`talkdesk_create_attribute`

Create a new routing attribute

`attributes:write`

Update An Attribute`talkdesk_update_attribute`

Update an existing routing attribute

`attributes:write`

Remove Association Of Users To An Attribute`talkdesk_remove_attribute_users`

Remove user-attribute association

`attributes:write`

Attributes Categories List`talkdesk_attribute_categories_list`

Attributes Categories List

`attributes:read`

Create A New Attribute Category`talkdesk_create_new_attribute_category`

Create a new attribute category

`attributes:write`

Get Call Recordings List`talkdesk_list_call_recordings`

Get a list of recordings for a specific call

`recordings:read`

List Prompts (audio Files) From Studio Flows`talkdesk_list_prompts`

List all audio prompts

`prompts:read`

Get A Prompt Detail By Its ID`talkdesk_get_prompt`

Retrieve a specific audio prompt by ID

`prompts:read`

Create Prompt`talkdesk_create_prompt`

Create a new audio prompt

`prompts:write`

Partially Updates The Prompt`talkdesk_update_prompt`

Partially update an existing audio prompt

`prompts:write`

Delete A Prompt`talkdesk_delete_prompt`

Delete an audio prompt

`prompts:delete`

Get Report Jobs By Type`talkdesk_list_report_jobs_by_type`

Get report jobs for a specific report type

`data-reports:read`

Creates A New Report Job`talkdesk_create_new_report_job`

Create a new report job

`data-reports:write`

Get Job Report Execution Details`talkdesk_get_job_report_execution_details`

Get report job execution details

`data-reports:read`

Get Job Report Execution Result`talkdesk_get_job_report__execution_file`

Download report execution result

`data-reports:read`

## Events

Tags

Select all
|
Clear

Agents

Calls

Contacts

Interactions

Webhooks

No tags found

7 events

EventDescriptionTags

Call Initiated Event`talkdesk_webhook_call_initiated`

Processes Talkdesk call initiated events when a new call begins.

CallsWebhooks

Call Completed Event`talkdesk_webhook_call_completed`

Processes Talkdesk call completed events when a call ends.

CallsWebhooks

Interaction Created Event`talkdesk_webhook_interaction_created`

Processes Talkdesk interaction created events when a new interaction starts.

InteractionsWebhooks

Interaction Updated Event`talkdesk_webhook_interaction_updated`

Processes Talkdesk interaction updated events when an interaction changes state.

InteractionsWebhooks

Agent Status Changed Event`talkdesk_webhook_agent_status_changed`

Processes Talkdesk agent status change events when an agent goes online, offline, or changes availability.

AgentsWebhooks

Contact Created Event`talkdesk_webhook_contact_created`

Processes Talkdesk contact created events when a new contact is added.

ContactsWebhooks

Contact Updated Event`talkdesk_webhook_contact_updated`

Processes Talkdesk contact updated events when a contact is modified.

ContactsWebhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.