> This page is for version Scripted.
> For other versions, use one of these documentation indexes:
> - Generative (default): https://developers.ada.cx/generative/llms.txt
> - Scripted: https://developers.ada.cx/scripted/llms.txt

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://developers.ada.cx/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developers.ada.cx/_mcp/server.

# Create customizable email tickets using the Zendesk Ticketing app

## Overview\[#UUID-e9a9d4c5-e3c9-7cc9-c741-668a21873e4f_id_4402477248915_id_h_01F9VWV44S7Z2N00ZAKBCQQZCV]

The Zendesk Ticketing app lets your chatters create email support
requests, then sends them to your Zendesk Support team. For those
familiar with Ada's original Zendesk Email Ticketing block, the
functionality is essentially the same; however, the new app gives you
more control over the information that is shared with your Zendesk
Support environment. It also adds the opportunity to further customize
the ticket directly from the bot.

Here are some examples of ticket customizations supported by the Zendesk
Ticketing app:

* Set the ticket Subject

* Set the Request Type

* Update the Ticket Status

* File Upload

## How a Zendesk Ticketing handoff works in Ada\[#UUID-e9a9d4c5-e3c9-7cc9-c741-668a21873e4f_id_4402477248915_id_h_01FAAAG5Z98E4XHXDXGM6TFQ6W]

The primary goal of a ticketing handoff Answer is to collect information
from the chatter to share with your support team. You need to capture
the chatter's contact information and their issue details. Once this is
done, the Zendesk Ticketing app can complete the process by sharing that
information with your Zendesk environment.

The Zendesk Ticketing app is a passive block. This means that it does
not capture any data from the chatter by itself. Any chatter information
you wish to pass to your Zendesk environment using the Zendesk Ticketing
app must be collected separately as variables.

Let's look at the three blocks necessary to build a Zendesk ticketing
handoff Answer.

### Capture blocks\[#UUID-e9a9d4c5-e3c9-7cc9-c741-668a21873e4f_id_4402477248915_id_h_01FAAA4QFFAA0SA8Q4WXPEAAQ7]

Capture blocks capture information directly from the chatter and save it
as a variable.

You can capture anything you think is relevant for the support request
ticket; however, there are three pieces of chatter information you must
capture for a most effective ticketing experience:

* Name

* Email

* Support issue

The Name and Email variables are critical requirements. Without them,
the Ticketing app is not considered complete and the Save button won't
illuminate. Though Support Issue is not a block requirement, in most
cases it is essential that you capture this information. Without it, the
Zendesk agent assigned to the ticket may not know what the support
request is about.

> **Info**
>
> * The **Name** and **Email** variables must be titled exactly as listed
>   above so that Zendesk recognizes them as chatter profile variables and
>   maps them correctly.
>
> * Set the Capture block **Validation** to email when capturing the
>   chatter's email address. This ensures the chatter enters a valid email
>   address by allowing the block to reject an entry that is not formed in
>   an email address format.

### The Fetch Chat Metadata block\[#UUID-e9a9d4c5-e3c9-7cc9-c741-668a21873e4f_id_4402477248915_id_h_01FAAA6Z2XATS1EKN1HC6QHWY5]

The Fetch Chat Metadata block is necessary to capture conversation
transcript and metadata, and save it as a [local, global, or sensitive variable](/scripted/docs/build-and-maintain-your-bot/personalize-conversations/get-started-with-variables).
Attaching the chatter info and the chat transcript to a handoff Answer
is only possible by using the Fetch Metadata block.

### The Zendesk Ticketing app\[#UUID-e9a9d4c5-e3c9-7cc9-c741-668a21873e4f_id_4402477248915_id_h_01F9VWVHC6J04B370SB9FJEBD7]

The **Zendesk Ticketing app** is the main component of a Zendesk Support
request Answer, also known as a ticketing Answer. Once triggered, a
ticketing Answer gathers the support request information from a chatter.
This information is then used to create a support ticket in your
**Zendesk environment**. The Zendesk Ticketing app job is to connect
with the Zendesk API, which in turn takes that information and creates
the ticket. Check out this article for more [information about handoffs](/scripted/docs/build-and-maintain-your-bot/create-conversations/hand-chatters-off-to-a-human-agent).

## Configure the Zendesk Ticketing App\[#UUID-e9a9d4c5-e3c9-7cc9-c741-668a21873e4f_id_4402477248915_id_h_01F9VWVD029JWADWHAVJX8BY42]

To use the Zendesk Ticketing App, you must first connect Ada with your
Zendesk Support account.

You'll need the following information from Zendesk:

* Your company's [Zendesk subdomain](https://support.zendesk.com/hc/en-us/articles/4409381383578-Where-can-I-find-my-Zendesk-subdomain-)

* A neutral Zendesk admin email

* A [Zendesk API token](https://support.zendesk.com/hc/en-us/articles/4408889192858)

If you have everything in order, then let's start:

1. On the Ada dashboard, click **Settings**, then click
   **Integrations**.

2. Under **App Integrations**, go to **Zendesk Ticketing** and click
   **Connect**. The configuration window appears.

3. In the configuration window, enter your **Zendesk Subdomain**.

4. Enter your team's **Zendesk Login Email**. This must be an admin
   level account.

   > **Info**
   >
   > Use a general admin account that's not associated with a specific
   > person. If, for any reason, you downgrade or remove this person's
   > Zendesk account, then the integration will break and support tickets
   > are no longer sent. On the other hand, a general admin account is
   > not very likely to have its admin privileges revoked.

5. Enter your **Zendesk API Token**.

   > **Info**
   >
   > If you need to [create a new token](https://support.zendesk.com/hc/en-us/articles/4408889192858),
   > be sure to use the same admin account you used to connect Ada with
   > your Zendesk account.

6. Click **Save**.

![](/_fern-files/_img/9dcee8c68dd9a9d81346eb0d479a8b5a0a754a0e95c0b1cd5a6096a7a1f01da4.webp)

## Gathering the information required to create a ticket\[#UUID-e9a9d4c5-e3c9-7cc9-c741-668a21873e4f_id_4402477248915_id_h_01FAAAM2VEM2TQ6QQ1FCMWTB4V]

The following chatter information is necessary to create a Zendesk
ticket:

* The chatter's name

* The chatter's email

* The chat transcript

You can gather the chatter's **name** and **email** address by using
[Capture blocks](/scripted/docs/build-and-maintain-your-bot/work-with-blocks-and-apps/save-chatter-information-using-the-capture-block)
to ask them for it directly. Remember to place the Capture blocks
*before* the Zendesk Ticketing app block.

The **chat transcript**, however, must be captured using the [Fetch Chat Metadata block](/scripted/docs/build-and-maintain-your-bot/work-with-blocks-and-apps/generate-a-chat-transcript-using-the-fetch-chat-metadata-block)
to save it as a variable. This variable can then be attached to the
ticket, typically in the **Comment** field.

### The Fetch Chat Metadata block\[#UUID-e9a9d4c5-e3c9-7cc9-c741-668a21873e4f_id_4402477248915_id_h_01FAAAR7MTXM0V1K4XSDFC99HP]

1. Click the **Select Action** drop-down menu, then click **Fetch Chat
   Metadata**.

2. Under **Select Variables for Inputs**, add the **chatter_token**
   metavariable to the **Chatter Token** field.

3. \[Optional] Under **Save Response as Variables**, click the
   **Select Optional Variable** drop-down menu, and select the options
   you’d like to capture in variables.

   > **Note**
   >
   > Unlike the original Zendesk Ticketing block, this new block does not
   > automatically capture the chat transcript or chatter info (i.e., the
   > metadata that is immediately recorded from a chatter's
   > browser/device). You must select the optional variables in this step
   > in order to pass them to the Zendesk ticket.

4. Assign variables to the options you selected in step 3.

   > **Note**
   >
   > It is best practice to give variables the same names as the field
   > titles. Use **chat_transcript** and **chatter_info**, respectively.

5. Under **Fallback Answer**, select an Answer to serve your chatters
   in case of a connection error with the Zendesk API.

6. Click **Save**.

## Use the Zendesk Ticketing app block\[#UUID-e9a9d4c5-e3c9-7cc9-c741-668a21873e4f_id_4402477248915_id_h_01FAAAP45T1340X5VQ2WFK48RP]

1. On the **Ada Dashboard**, drag and drop the **Zendesk Ticketing
   App** block into your handoff Answer.

2. Click the **Select Action** drop-down menu, then click **Create
   Ticket**. The **Select Variables for Inputs** section appears.

   ![](/_fern-files/_img/03a37b2cad6dffa5a40fdb425bcc68599087115f34f1e59c94c3bfde3e6c0095.webp)

3. Complete the **mandatory input fields**, and any **optional input
   fields** as needed. Use the following tables to understand the
   requirements for each field.

   > **Note**
   >
   > You may see more inputs in your Optional Inputs drop-down menu than
   > the three constant options listed in the table below. The menu
   > populates with additional input options dynamically, based on what
   > is available in your Zendesk Support environment.

   <table>
     <thead>
       <tr>
         <th>
           Mandatory Input
         </th>

         <th>
           Description
         </th>
       </tr>
     </thead>

     <tbody>
       <tr>
         <td>
           **Comment**
         </td>

         <td>
           Add the chat transcript variable from the *Fetch Chat
           Metadata* block. You can also add plaintext notes.

           > **Tip**
           >
           > You can use line breaks in your comment for tidier formatting. To do
           > so, add `\n` wherever you want the line break to
           > occur.
         </td>
       </tr>

       <tr>
         <td>
           **Chatter's Name**
         </td>

         <td>
           Add the *Name* variable. This could be a variable captured
           with the Capture block, or a metavariable passed from the chatter's
           account.
         </td>
       </tr>

       <tr>
         <td>
           **Chatter's Email**
         </td>

         <td>
           Add the *email* variable, captured either using a Capture
           block, or passed for your database as a metavariable.
         </td>
       </tr>
     </tbody>
   </table>

   <table>
     <thead>
       <tr>
         <th>
           Optional Input
         </th>

         <th>
           Description
         </th>
       </tr>
     </thead>

     <tbody>
       <tr>
         <td>
           **Attach Comment To**
         </td>

         <td>
           Add one of the following to indicate where to attach the
           comment:

           * **internal note**
           * **public reply**

           > **Note**
           >
           > By default, comments are attached to internal notes.
         </td>
       </tr>

       <tr>
         <td>
           **File Data Token**
         </td>

         <td>
           Used to attach file upload data. Add the **File Data Token
           variable** generated by the File Upload App.
         </td>
       </tr>

       <tr>
         <td>
           **Tags**
         </td>

         <td>
           Use this field to add **Tags** to your tickets.

           * You can type in plain text, or use variables.
           * Separate each tag with a comma.
           * Use underscores instead of spaces in tags (e.g., `accounts,forgot_password,sign_in_issues`)
           * Avoid special characters in tags. For more information on how
             special characters work in tags, see [Working with ticket tags](https://support.zendesk.com/hc/en-us/articles/4408835059482-Working-with-ticket-tags) at Zendesk's documentation.
         </td>
       </tr>

       <tr>
         <td>
           **Custom Fields**
         </td>

         <td>
           When you create custom fields in your tickets, Zendesk
           automatically populates the names into your block. Then, you can
           associate those field names with the tag values you want to populate
           them with. For more information, see [Adding custom fields to your tickets and support request form](https://support.zendesk.com/hc/en-us/articles/4408883152794-Adding-custom-fields-to-your-tickets-and-support-request-form) at Zendesk's documentation.

           * If you have conditional fields in your ticket, ensure that each
             field has a tag in it. If a conditional field doesn't have a tag
             associated with it, the handoff won't work. For more information, see [Creating conditional ticket fields](https://support.zendesk.com/hc/en-us/articles/4408834799770-Creating-conditional-ticket-fields) at Zendesk's documentation.

             Similarly, ensure that every field that's marked as Required in
             Zendesk has a tag associated with it. Otherwise, the handoff won't
             work.
           * When passing tag values into custom fields, make sure you use the
             same tag names that you have configured in those fields. A common
             mistake is using the display label (e.g., `Forgot password`)
             instead of the tag value (e.g. `forgot_password`), which
             prevents the tag from properly appearing on the ticket.
         </td>
       </tr>
     </tbody>
   </table>

   ![](/_fern-files/_img/d57ece8f9cde572c0d0abff2475dd07aca5a6eda15f6bf88767e7692c4957f33.webp)

4. Under **Save Response as Variables**, click the **Select Optional
   Variables** drop-down menu, then select **Ticket ID**.

5. Click **Choose a Variable**, and select an existing variable, or
   create a new variable, to capture the Zendesk ticket's **Ticket
   ID**.

6. Under **Fallback Answer**, click the **Choose an Answer** drop-down
   menu, then select a variable to display if an error occurs during
   the block’s operation.

7. Click **Save**.

You're done! The Zendesk Ticketing App block is now configured for
creating support tickets.

### Related Articles

[File Upload](/scripted/docs/build-and-maintain-your-bot/work-with-blocks-and-apps/let-chatters-upload-files-using-the-file-upload-block)

[Fetch Chat Metadata](/scripted/docs/build-and-maintain-your-bot/work-with-blocks-and-apps/generate-a-chat-transcript-using-the-fetch-chat-metadata-block)

---

Have any questions? Contact your Ada team, or email us at [](<mailto:help@ada.support%20%E2%80%9CHelp Docs inquiry%E2%80%9D>).