Zendesk Chat

undefined

Detail	Value
Category	Support
Base URL	https://{subdomain}.zendesk.com/api/v2/chat
Authentication	OAuth2
Endpoints	6
Connector key	zendesk-chat

Using Zendesk Chat in a workflow

1. Go to Connections and click New Connection.
2. Pick Zendesk Chat from the marketplace.
3. Enter your credentials (see Authentication above for what's expected).
4. In a workflow, drop an API Call node and select this connection.
5. Pick the operation you need from the Operation dropdown. The full list is below.

Available endpoints

Endpoint	Summary
GET	List Chats
GET	Search Chats
GET	List Agents
GET	Manage Agents
GET	Departments
GET	Triggers

Each endpoint is documented in full below. Use the outline on the right to jump to one.

GET

List Chats

Detail	Value
Operation ID	list_chats_0
Method	GET
Path	``

Parameters

No parameters.

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Zendesk Chat connection from the Connection dropdown.
3. In the Operation dropdown, select list_chats_0.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Zendesk Chat API reference.

GET

Search Chats

Detail	Value
Operation ID	search_chats_1
Method	GET
Path	``

Parameters

No parameters.

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Zendesk Chat connection from the Connection dropdown.
3. In the Operation dropdown, select search_chats_1.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Zendesk Chat API reference.

GET

List Agents

Detail	Value
Operation ID	list_agents_2
Method	GET
Path	``

Parameters

No parameters.

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Zendesk Chat connection from the Connection dropdown.
3. In the Operation dropdown, select list_agents_2.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Zendesk Chat API reference.

GET

Manage Agents

Detail	Value
Operation ID	manage_agents_3
Method	GET
Path	``

Parameters

No parameters.

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Zendesk Chat connection from the Connection dropdown.
3. In the Operation dropdown, select manage_agents_3.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Zendesk Chat API reference.

GET

Departments

Detail	Value
Operation ID	departments_4
Method	GET
Path	``

Parameters

No parameters.

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Zendesk Chat connection from the Connection dropdown.
3. In the Operation dropdown, select departments_4.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Zendesk Chat API reference.

GET

Triggers

Detail	Value
Operation ID	triggers_5
Method	GET
Path	``

Parameters

No parameters.

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Zendesk Chat connection from the Connection dropdown.
3. In the Operation dropdown, select triggers_5.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Zendesk Chat API reference.