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

# Cue Cards

> Cue Cards help your agents by showing up-to-date details, like client history, deal status, or custom call scripts.

> [!NOTE]
>
> This guide explains how to set up Cue Cards in CloudTalk so your agents see real-time customer details, scripts, or documents during calls.

**User Level:** Admin

***

## How Cue Cards Work

When a call starts, CloudTalk triggers a **Workflow Automation** that sends the call’s unique identifier (Call UUID) to your external system (CRM, Zapier, or custom backend).

Your external system then:

1. Uses the UUID to look up relevant customer or business data.

2. Prepares this data in the correct format (HTML or Blocks).

3. Sends the data back to CloudTalk via the [Cue Cards API](https://help.cloudtalk.io/api-reference/cuecard/create-cuecard.md).

CloudTalk immediately displays this data to the agent in CloudTalk Phone.

> [!WARNING]
>
> Cue Cards are available in the **CloudTalk Web App, Desktop App, and CTI integrations**. They are **not supported in the CloudTalk Go mobile app**.

![](https://mintcdn.com/cloudtalk/0LuB-WYxwheF-8cl/images/help-center/articles/11154936/f7c6162fdd45-product-knowledge-faq-uploads3cbf0d3c-d79d-41ed-90e2-00c4f8d.png?fit=max\&auto=format\&n=0LuB-WYxwheF-8cl\&q=85\&s=8c5dadd8f0443ecfce587e2e45660e0d)

## Setup Flow

### Configure Workflow Automation in CloudTalk

1. In your CloudTalk Dashboard, go to **[Workflow Automations](https://help.cloudtalk.io/en/articles/5450779-configuring-workflow-automations.md)**.

2. Click **+ Add Workflow**.

3. Select **Trigger**:

   * Object: `Call`

   * Action: `Answered` (or `Started`, depending on your use case)

     ![](https://mintcdn.com/cloudtalk/0LuB-WYxwheF-8cl/images/help-center/articles/11154936/de0eaa0ab98e-screenshot-2025-04-29-at-13-16-20.png?fit=max\&auto=format\&n=0LuB-WYxwheF-8cl\&q=85\&s=0039d3d5585dbc3d452184509d29687d)

4. (Optional) Add **Conditions**, e.g.:

   * Show only for inbound calls → `#{{ Call_direction == "Inbound" }}`

   * VIP tags, specific countries, or selected agents/groups

5. Add an **Action**: API Request.

   * Method: `POST`

   * Endpoint: URL of your external system (e.g., Zapier webhook or CRM API).

   * Headers: e.g., `Content-Type: application/json`

   * Values: include `call_uuid` → `#{{ Call_uuid }}`

![](https://mintcdn.com/cloudtalk/0LuB-WYxwheF-8cl/images/help-center/articles/11154936/a1212237907a-screenshot-2025-04-29-at-14-47-14.png?fit=max\&auto=format\&n=0LuB-WYxwheF-8cl\&q=85\&s=ea3ec40830b120b9d35ea9578b832f00)

CloudTalk now sends the Call UUID to your external system when a matching call is answered.

### Configure Logic in Your External Tool

Your external tool (CRM, Zapier, or custom backend) needs to handle four steps:

1. **Receive the request from CloudTalk**

   * CloudTalk Workflow Automation sends an HTTP POST to the endpoint you specify.

   * The request contains at least the `call_uuid` and any other values you’ve configured.

2. **Look up the data you want to display**

   * For example, fetch the caller’s CRM profile, recent order, or pull in a call script from your database.

3. **Build the Cue Card payload**

   * Format the response as either:

     * **HTML** (simple text/links), or

     * **Blocks** (structured fields like textfields, links, images, or files).

4. **Send the payload back to CloudTalk**

   * Make a POST request to the [Cue Cards API](https://help.cloudtalk.io/api-reference/cuecard/create-cuecard.md) including:

     * `call_uuid` (to match the correct call)

     * `type` (`html` or `blocks`)

     * `content` (the data you want shown)

Once CloudTalk receives the payload, the Cue Card will appear instantly in the agent’s panel.

### Example Setup in CloudTalk (with Zapier)

Here’s a simplified example of how you could connect CloudTalk Workflow Automations with Zapier to display Cue Cards:

**In CloudTalk (Step 1)**

* Create a Workflow Automation with **Trigger = Call Answered**.

* Add an **API Request Action** pointing to your Zapier Webhook URL.

* Send the following value:

  * `call_uuid → #{{ Call_uuid }}`

**In Zapier (Step 2)**

* **Catch Webhook**: Zapier receives the `POST` from CloudTalk with the `call_uuid`.

* **Look up data**: Use Zapier steps (e.g., search CRM records or fetch from a database).

* **Format Cue Card Payload**: Build a JSON body for the Cue Card API, for example:

```json theme={"system"}
{
  "call_uuid": "#{{Call_uuid}}",
  "type": "blocks",
  "content": [
    {
      "type": "textfield",
      "name": "Customer Name",
      "value": "Jane Smith"
    },
    {
      "type": "richtext",
      "name": "Script No. 123",
      "value": "Hello Jane, thank you for calling!"
    },
    {
      "type": "link",
      "name": "Profile",
      "url": "https://crm.example.com/clients/123"
    }
  ]
}
```

**Send to CloudTalk API (Step 3)**

* Use a Zapier Webhook **`POST`** step.

* Endpoint: [`https://platform-api.cloudtalk.io/api/cuecards`](https://platform-api.cloudtalk.io/api/cuecards)

* Headers:

  * `Content-Type: application/json`

  * `Authorization: Bearer <YOUR_API_KEY>`

* Body: The Cue Card JSON you prepared.

When the call is answered, Zapier looks up the data, builds the payload, and CloudTalk instantly displays the Cue Card to the agent.

***

*Need help or have a question?* Just reach out through our [Support portal](https://support.cloudtalk.io/hc/en-us/requests/new?ticket_form_id=26305535257884) — we’re here for you.


## Related topics

- [Create CueCard](https://help.cloudtalk.io/api-reference/cuecard/create-cuecard.md)
- [CloudTalk API Response Envelope Formats and Schema](https://help.cloudtalk.io/guides/response-envelopes.md)
- [CloudTalk REST API: Call Center Automation Platform](https://help.cloudtalk.io/guides/introduction.md)


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