Zendesk

The official Zendesk integration allows you to create and manage support tickets directly from your bot. You can also assign a Zendesk agent to communicate directly with the user, all within the same conversation initially handled by the bot.

Zendesk integration versions below v3.0.0 are deprecated and will be retired on January 12, 2026.To avoid disruptions, upgrade to v3.0.0+ and reconnect using OAuth. If you’re already on v3.0.0+, no further action is required.

Setup

You will need:

A published bot
A Zendesk account

We recommend that you only link your Zendesk account with one bot. Linking the same Zendesk account with multiple bots will raise an error and cause unexpected behaviour.

In Botpress Studio, select Explore Hub in the upper-right corner.

Search for the Zendesk integration, then select Install Integration.

In the Configuration menu, select Authorize Zendesk.

Follow the instructions to connect Botpress to your Zendesk account.

Done! You can now create and manage support tickets directly from your bot.

Cards

Here’s a reference for all Cards available with the integration:

Call API

input

object

Show child attributes

method

enum<string>

required

Available options: GET, POST, PUT, PATCH, DELETE

Close ticket

output

object

Show child attributes

ticket

object

required

Show child attributes

status

enum<string>

required

Available options: new, open, pending, hold, solved, closed

priority

string | null

required

ticketFormId

string | null

assigneeId

number | null

required

externalId

string | null

required

Create Ticket

output

object

Show child attributes

ticket

object

required

Show child attributes

status

enum<string>

required

Available options: new, open, pending, hold, solved, closed

priority

string | null

required

ticketFormId

string | null

assigneeId

number | null

required

externalId

string | null

required

Find Customer

output

object

Show child attributes

customers

array

required

Show array item properties

phone

string | null

photo

string | null

remotePhotoUrl

string | null

role

enum<string>

required

Available options: end-user, agent, admin

externalId

string | null

required

Get ticket

output

object

Show child attributes

ticket

object

required

Show child attributes

status

enum<string>

required

Available options: new, open, pending, hold, solved, closed

priority

string | null

required

ticketFormId

string | null

assigneeId

number | null

required

externalId

string | null

required

List Agents

output

object

Show child attributes

agents

array

required

Show array item properties

phone

string | null

photo

string | null

remotePhotoUrl

string | null

role

enum<string>

required

Available options: end-user, agent, admin

externalId

string | null

required

Sync Knowledge Base

Triggers

Here’s a reference for all Triggers available with the integration:

You can access data returned from any of these Triggers by reading event.payload after the Trigger fires.

Setup

Cards

Call API

Close ticket

Create Ticket

Find Customer

Get ticket

List Agents

Sync Knowledge Base

Triggers

Article Published

Article Unpublished

​Setup

​Cards

​Call API

​Close ticket

​Create Ticket

​Find Customer

​Get ticket

​List Agents

​Sync Knowledge Base

​Triggers

​Article Published

​Article Unpublished

Setup

Cards

Call API

Close ticket

Create Ticket

Find Customer

Get ticket

List Agents

Sync Knowledge Base

Triggers

Article Published

Article Unpublished