> For the complete documentation index, see [llms.txt](https://help.botpenguin.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.botpenguin.com/bots/whatsapp-bot/manage-chatflow/components-in-chatflow/integrations-component/zendesk-integration-component.md).

# Zendesk Integration Component

### What is Zendesk Integration?

Zendesk is a customer support platform where businesses manage and respond to customer queries using a ticketing system. Each support request raised by a customer becomes a **ticket** in Zendesk, which your support team can track, assign, and resolve.

By connecting and using Zendesk component directly in your WhatsApp Chatbot on BotPenguin, you can automatically create or update Zendesk tickets based on what a customer shares during a conversation — without anyone having to manually log the request.

***

### When Should You Use This?

Use Zendesk component when:

* You want every WhatsApp conversation that needs support to automatically create a ticket in Zendesk
* You want to update an existing ticket with new information collected through the chatbot
* You want your support team to receive structured, ready-to-action tickets from WhatsApp conversations

***

### How It Works

The setup has two parts:

1. **Connect Zendesk** — You authenticate your Zendesk account inside BotPenguin and map your chatbot questions to Zendesk ticket fields. This tells BotPenguin what data to send and where.
2. **Add the Zendesk component to your Chatflow** — Once connected, you place the Zendesk component at the right point in your WhatsApp Chatflow. When the conversation reaches that point, BotPenguin automatically creates or updates a ticket in Zendesk using the information collected.

***

### Before You Begin

* An active BotPenguin account with a WhatsApp Chatbot set up
* A Zendesk account with admin access
* A Chatflow that collects customer details such as name, email, and issue description

***

### Step-by-Step Instructions

#### Part A: Get Your Zendesk API Credentials

You will need three things from your Zendesk account: an **API Token**, your **account email address**, and your **API URL**.

#### Step 1: Log in to Zendesk Admin Center

1. Log in to your Zendesk account.
2. Click the **Support** dropdown at the top left and select **Admin Center**.

<figure><img src="/files/w0O2uAlM9mYsvJE69CQG" alt=""><figcaption></figcaption></figure>

#### Step 2: Enable API Token Access

1. In Admin Center, navigate to **Apps and Integrations → APIs → API Tokens**.
2. If you see a message saying "API token access is off", click **View token access configuration**.

<figure><img src="/files/HX6Tn1aQF5i9vAFdp7OD" alt=""><figcaption></figcaption></figure>

3. Check the **Allow API token access** checkbox and click **Save**.

<figure><img src="/files/xZTB7JJCidE1tkwbLzfU" alt=""><figcaption></figcaption></figure>

#### Step 3: Generate an API Token

1. Go back to **API Tokens** and click **Add API Token**.
2. Enter a description so you can identify it later. Example: `BotPenguin Integration`

<figure><img src="/files/QSWAHaPrniO5IvwoAl74" alt=""><figcaption></figcaption></figure>

3. Click **Save**. Your token will appear on screen.

<figure><img src="/files/62VcRFOsqguuXryYo23k" alt=""><figcaption></figcaption></figure>

> ⚠️ Copy the token immediately and store it somewhere safe — a notes app or password manager. Zendesk will not show this token again after you leave the page.

#### Step 4: Note Your Email Address and API URL

You will also need:

* **Email Address** — The email address you use to log in to your Zendesk account
* **API URL** — This is your Zendesk subdomain URL. It follows the format:\
  `https://yourcompanyname.zendesk.com`

You can find this in your browser's address bar when you are logged in to Zendesk.

***

#### Part B: Connect Zendesk in BotPenguin

#### Step 1: Open Third Party Integration

1. From the left sidebar, click **Chatbot**.
2. Select the WhatsApp chatbot you want to connect to Zendesk from the dropdown at the top.
3. In the left menu under your chatbot, click **Third Party Integration**.

This is where BotPenguin lists all the external tools you can connect to your chatbot.

<figure><img src="/files/usntKKgnZS2LechURTtH" alt=""><figcaption></figcaption></figure>

***

#### Step 2: Find and Connect Zendesk

1. In the search bar on the integrations page, type **Zendesk**.
2. Click **Connect** next to the Zendesk result.

<figure><img src="/files/vcQBcStHTkZjNCZW1Ebq" alt=""><figcaption></figcaption></figure>

3. On the Zendesk detail page that opens, click **Connect** again to begin the setup.

<figure><img src="/files/XOXBKjczcVaPuJ7CDsJT" alt=""><figcaption></figcaption></figure>

***

#### Step 3: Enter Your Credentials

A connection form will appear with three fields:

**API Token**\
Paste the API token you copied from Zendesk in Part A. This is the key that allows BotPenguin to communicate with your Zendesk account securely.

**Email Address**\
Enter the email address you use to log in to your Zendesk account. Zendesk uses this alongside the API token to verify your identity.

**API URL**\
Enter your Zendesk account URL. This is the web address of your Zendesk account, in the format:\
`https://yourcompanyname.zendesk.com`

<figure><img src="/files/ExTx4W2xYnqaXZdptiO2" alt=""><figcaption></figcaption></figure>

***

#### Step 4: Click Connect

Once all three fields are filled in, click **Connect**.

If the credentials are correct, Zendesk will be connected and you will be taken to the configuration screen where you can set up your mappings.

#### Step 5: Select a Trigger Type

You will see a field called **When to Trigger**. This controls when BotPenguin sends data to Zendesk.

Two options are available:

| Option                          | What it does                                                                        |
| ------------------------------- | ----------------------------------------------------------------------------------- |
| **Based On Lead Alert Trigger** | Automatically sends data to Zendesk whenever a new lead is generated by the chatbot |
| **Based On Chat Flow Trigger**  | Sends data to Zendesk only when the Zendesk component is reached in your Chatflow   |

Select **Based On Chat Flow Trigger** if you want precise control over when tickets are created. Select **Based On Lead Alert Trigger** if you want every new lead to automatically create a ticket.

<figure><img src="/files/cYeZRBbrMSk2cqgXg4lx" alt=""><figcaption></figcaption></figure>

***

#### Step 4: Map Your Chatbot Questions to Zendesk Fields

This step tells BotPenguin which chatbot question answers should go into which Zendesk ticket fields.

Under **Questions**, you will see two dropdowns side by side:

* The left dropdown — **Select Questions** — is where you pick the chatbot question whose answer you want to send to Zendesk. For example: "What is your email address?"

<figure><img src="/files/4HxZHTaczb0wDgpzerqO" alt=""><figcaption></figcaption></figure>

* The right dropdown — **map with → Select Parameter** — is where you select the corresponding Zendesk field that should receive that answer. For example: Email

<figure><img src="/files/i99VSYplnJU3MvrJrNiD" alt=""><figcaption></figcaption></figure>

Click **+ Add Parameters** to add more question mappings.

Example mappings:

| Chatbot Question            | Zendesk Field |
| --------------------------- | ------------- |
| What is your name?          | Name          |
| What is your email address? | Email         |
| How can we help you?        | Description   |

***

#### Step 5: Map Custom Attributes (Optional)

If your chatbot stores additional customer information as **Custom Attributes** — such as order number, location, or membership ID — you can map those to Zendesk fields here as well.

Under **Custom Attribute**, use the same two-dropdown format:

* Left dropdown — select the Custom Attribute

<figure><img src="/files/z3bDsV0Qgja7qrCIiMpS" alt=""><figcaption></figcaption></figure>

* Right dropdown — select the Zendesk field to map it to

Click **+ Add Parameters** to add more attribute mappings.

***

#### Step 6: Save the Configuration

Once all mappings are set, click **Save**.

Zendesk is now connected to your WhatsApp chatbot. The next step is to add the Zendesk component to your Chatflow so it knows exactly when to send data.

***

#### Part C: Add the Zendesk Component to Your Chatflow

Once Zendesk is connected, you need to place the Zendesk component in your WhatsApp Chatflow at the point where you want a ticket to be created or updated.

#### Step 1: Open the Chatflow Builder

1. From the left sidebar, click **Chatbot**.
2. Go to **Chat Flows**.
3. Open the Chatflow you want to edit.

#### Step 2: Add the Zendesk Component

1. On the left side of the builder, you will see a panel called **Add Chat Component**.
2. Scroll down to the **Integrations** section and expand it.
3. Click on **Zendesk** to add it to the canvas.

The Zendesk component will appear on the Chatflow canvas.

<figure><img src="/files/vYevw7jwaYgXzUH0sDPR" alt=""><figcaption></figcaption></figure>

***

#### Step 3: Configure the Component

Click on the Zendesk component on the canvas to open its settings on the right side of the screen.

You will see two fields:

**Message**\
This is the name that appears on the component card in the canvas. It is just a label to help you identify this step in the flow. Example: `Create Zendesk Ticket`

**Choose Action**\
This is where you select what the component should do when the conversation reaches it. Two options are available:

| Action     | What it does                                               |
| ---------- | ---------------------------------------------------------- |
| **Add**    | Creates a new ticket in Zendesk using the mapped data      |
| **Update** | Updates an existing ticket in Zendesk with new information |

<figure><img src="/files/o6ZlqVOkUPEBMQmaFzfq" alt=""><figcaption></figcaption></figure>

***

#### Step 4: Position the Component in the Flow

Make sure the Zendesk component is placed after the questions that collect the information you mapped in Part A. This ensures the data is available before the ticket is created or updated.

### Best Practices

> 💡 Always map at least the customer's **Name** and **Email** so Zendesk tickets have enough information for your support team to follow up.

> 💡 Place the Zendesk component after all the questions that collect the data you need — not before.

> 💡 Copy and store your Zendesk API token immediately after generating it. It cannot be retrieved later.

> 💡 Test the full conversation end-to-end before pointing real customers to the bot — check that tickets appear correctly in Zendesk.

> 💡 Use a clear, descriptive label in the **Message** field (e.g. "Create Support Ticket") so your Chatflow is easy to read and maintain.

***

### What Might Go Wrong

| Situation                                                 | What Happens                                                        |
| --------------------------------------------------------- | ------------------------------------------------------------------- |
| API token not entered or entered incorrectly              | Zendesk connection will fail                                        |
| Chatbot questions not mapped to Zendesk fields            | Tickets will be created with missing or empty fields                |
| Zendesk component placed before data-collecting questions | Ticket will be created before the required information is available |
| API token access disabled in Zendesk Admin Center         | Connection will fail even if the token is correct                   |
| Token lost before saving                                  | A new token must be generated in Zendesk                            |

***

### Troubleshooting

<details>

<summary>Zendesk is not connecting when I click Save</summary>

* Confirm that your Zendesk API token has been copied correctly without any extra spaces.
* Verify that API token access is enabled in **Zendesk Admin Center → Apps and Integrations → APIs**.
* If necessary, generate a new API token and reconnect the integration.

</details>

<details>

<summary>Tickets are being created with empty or missing fields</summary>

* Review your field mappings under **Third Party Integration → Zendesk**.
* Ensure the chatbot questions and customer attributes you've mapped are collected before the Zendesk component is reached.
* Save the configuration again after making any mapping changes.

</details>

<details>

<summary>The Zendesk component is not visible in the Chatflow builder</summary>

* Ensure Zendesk has been successfully connected and saved under **Third Party Integration**.
* Refresh the Chatflow Builder.
* Check the **Integrations** section in the **Add Chat Component** panel.

</details>

<details>

<summary>No ticket is created in Zendesk after testing</summary>

* Verify that the Zendesk component is correctly connected within your Chatflow.
* If using **Chat Flow Trigger**, ensure the conversation reaches the Zendesk component.
* Confirm your Zendesk account has the required API permissions and supports API access.

</details>

***

### FAQs

<details>

<summary>Is the Zendesk component available for all bot types?</summary>

No. The Zendesk component is currently available only for **WhatsApp Chatbots**.

</details>

<details>

<summary>What is the difference between the Add and Update actions?</summary>

**Add** creates a new Zendesk ticket each time the component is executed. **Update** modifies an existing ticket with information collected during the current conversation.

</details>

<details>

<summary>What is the difference between Chat Flow Trigger and Lead Alert Trigger?</summary>

**Chat Flow Trigger** creates or updates a ticket only when the chatbot reaches the Zendesk component in the Chatflow. **Lead Alert Trigger** automatically sends lead information to Zendesk whenever a new lead is generated, without requiring a Zendesk component in the flow.

</details>

<details>

<summary>Can I map custom attributes to Zendesk fields?</summary>

Yes. You can map both chatbot questions and customer attributes to Zendesk ticket fields from the **Third Party Integration → Zendesk** configuration page.

</details>

<details>

<summary>What happens if I lose my Zendesk API token?</summary>

Generate a new API token from **Zendesk Admin Center → Apps and Integrations → APIs → API Tokens**, then reconnect the integration in BotPenguin using the new token.

</details>

<details>

<summary>Do I need to add the Zendesk component to every Chatflow?</summary>

No. Only add the Zendesk component to the Chatflows where you want tickets to be created or updated.

</details>

***

### Support

If everything is correct and you are still unable to move forward, write to us at <support@botpenguin.com>. We will respond back within 48 business hours.