# Talkdesk
URL: https://docs.awellhealth.com/docs/marketplace/talkdesk

> For the complete documentation index, see [llms.txt](https://docs.awellhealth.com/llms.txt).



<img src="/marketplace/talkdesk.jpg" width="48" height="48" />

Talkdesk is a cloud-based customer experience and contact center software company.

Category: Communication. Adds 1 action to a care flow.

## What to configure [#what-to-configure]

Set these once, on the extension in Awell Studio. An action fails at run time if a
required setting is missing.

| Setting               | Required | Notes                                                                     |
| --------------------- | -------- | ------------------------------------------------------------------------- |
| Client ID             | Yes      | The client ID for OAuth2 Password authentication.                         |
| Client Secret         | Yes      | The client secret for OAuth2 Password authentication. Stored as a secret. |
| Region                | No       | US, EU, or Canada. Defaults to US.                                        |
| Talkdesk account name | Yes      | —                                                                         |

## Actions [#actions]

Talkdesk adds this action to a care flow. Add one to a step, then fill in its inputs.

### Trigger flow [#trigger-flow]

Trigger a flow in Talkdesk

| Input        | Type      | Required | Description                                                                                                                                                 |
| ------------ | --------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Flow ID      | `string`  | Yes      | The ID of the flow you would like to trigger                                                                                                                |
| Autocomplete | `boolean` | No       | If true, the activity will not wait for the flow to complete (default: false)                                                                               |
| Data         | `json`    | Yes      | Data to be ingested when triggering the flow, including the `awell_activity_id` so the flow can perform the appropriate completeExtensionActivity callback. |

Returns:

| Data point         | Type     |
| ------------------ | -------- |
| `agent`            | `string` |
| `call_duration_ms` | `number` |
| `call_end_time`    | `date`   |
| `call_start_time`  | `date`   |
| `call_status`      | `string` |
| `disposition`      | `string` |
| `flowVersionId`    | `string` |
| `interactionId`    | `string` |

Enables the initiation of a Talkdesk flow directly from an Awell careflow. This feature triggers an interaction using the most recent published version of a specific Studio flow. You'll need to supply the ID of the flow and the data (as a JSON object) that you want to input into the flow.

Important: Please note that Talkdesk sets a restriction of up to two API requests per second (rps) for each account using their Flows API.

[Click here](https://studio.talkdesk.com/docs/sending-notifications-to-contacts-via-api-request) to learn more about triggering flows via the Talkdesk API and here to read the [API docs](https://docs.talkdesk.com/reference/flows-api-ref).

## Setup and notes [#setup-and-notes]

Talkdesk is a cloud-based customer experience and contact center software company. It provides a platform that enables businesses to set up and manage their customer service and support operations. Talkdesk offers a range of features and tools to streamline and enhance communication between businesses and their customers.

### Setup [#setup]

To set up the extension, you'll need your Talkdesk account name along with a client ID and client secret. Please ensure that the credentials you provide are associated with the necessary permissions, or "scopes," to run the extension:

* flows-interactions:start

## Where this page comes from [#where-this-page-comes-from]

The settings, actions, inputs, outputs and webhooks above are generated from the
extension's own code, at `@awell-health/awell-extensions` v2.1.159. They match what the
platform actually does rather than a description of it.

Field-level detail also appears in Awell Studio when you configure the action.
Something wrong or missing? Email [support@awellhealth.com](mailto:support@awellhealth.com).
