Zendesk is a customer service and sales platform that helps businesses manage customer interactions across various channels.

Categories: Surveys and Feedback

Type: zendesk/v1

Connections

Version: 1

basic_auth

Properties

Name	Label	Type	Description	Required
api_token	API Token	STRING	API tokens are managed in the Admin Center interface at Apps and integrations > APIs > API Tokens.	true
email	Email	STRING	Your Zendesk account email.	true
subdomain	Subdomain	STRING	Subdomain of your Zendesk account (e.g. https://SUBDOMAIN.zendesk.com).	true

Actions

Add Comment to Ticket

Name: commentTicket

Adds a comment to an existing ticket.

Properties

Name	Label	Type	Description	Required
ticketId	Ticket ID	INTEGER	ID of the ticket that will get the comment.	true
comment	Comment	STRING	A ticket comment.	true

Example JSON Structure

{
  "label" : "Add Comment to Ticket",
  "name" : "commentTicket",
  "parameters" : {
    "ticketId" : 1,
    "comment" : ""
  },
  "type" : "zendesk/v1/commentTicket"
}

Properties

Name	Type	Description
url	STRING	API URL of the ticket resource.
id	INTEGER	Ticket ID.
external_id	INTEGER	External ID of the ticket.
via	OBJECT Properties {STRING(channel), {{}(from), {}(to), {}(rel)}(source)}	Information for how the ticket was created.
created_at	STRING	Timestamp when the ticket was created.
updated_at	STRING	Timestamp of the last update to the ticket.
generated_timestamp	INTEGER	UNIX timestamp when the ticket was generated.
type	STRING	Type of the ticket.
subject	STRING	Subject line of the ticket.
raw_subject	STRING	Unprocessed subject line of the ticket.
description	STRING	Detailed description of the ticket issue.
priority	STRING	Priority of the ticket.
status	STRING	Current status of the ticket.
recipient	STRING	Email address of the ticket recipient.
requester_id	INTEGER	ID of the user who requested the ticket.
submitter_id	INTEGER	ID of the user who submitted the ticket.
assignee_id	INTEGER	ID of the agent assigned to the ticket.
organization_id	INTEGER	ID of the organization associated with the requester.
group_id	INTEGER	ID of the group associated with the ticket.
collaborator_ids	ARRAY Items [INTEGER]	List of user IDs who are collaborators on the ticket.
follower_ids	ARRAY Items [INTEGER]	List of user IDs following the ticket.
email_cc_ids	ARRAY Items []	List of ticket CCs user IDs.
forum_topic_ids	ARRAY Items []	List of forum ID topics.
problem_id	INTEGER	ID of the problem the ticket is linked to.
has_incidents	BOOLEAN Options true, false	Whether the ticket has related incidents.
is_public	BOOLEAN Options true, false	Whether the ticket is public.
due_at	STRING	Due date for the ticket, if any.
tags	ARRAY Items [STRING]	List of tags associated with the ticket.
custom_fields	ARRAY Items [{INTEGER(id), STRING(value)}]	Custom field values associated with the ticket.
satisfaction_rating	OBJECT Properties {STRING(comment), INTEGER(id), STRING(score)}	Customer satisfaction rating for the ticket.
sharing_agreement_ids	ARRAY Items [INTEGER($id)]	List of sharing agreement IDs for the ticket.
custom_status_id	INTEGER	Custom status ID for the ticket.
encoded_id	STRING	Encoded ticket ID.
fields	ARRAY Items [{INTEGER(id), STRING(value)}($item)]	Ticket fields.
followup_ids	ARRAY Items []	Array of follow up IDs.
ticket_form_id	INTEGER	Ticket form ID.
brand_id	INTEGER	Brand ID.
allow_channelback	BOOLEAN Options true, false	Whether channelback is allowed for the ticket.
allow_attachments	BOOLEAN Options true, false	Whether attachments are allowed for the ticket.
from_messaging_channel	BOOLEAN Options true, false	Indicates if the ticket originated from a messaging channel.

Output Example

{
  "url" : "",
  "id" : 1,
  "external_id" : 1,
  "via" : {
    "channel" : "",
    "source" : {
      "from" : { },
      "to" : { },
      "rel" : { }
    }
  },
  "created_at" : "",
  "updated_at" : "",
  "generated_timestamp" : 1,
  "type" : "",
  "subject" : "",
  "raw_subject" : "",
  "description" : "",
  "priority" : "",
  "status" : "",
  "recipient" : "",
  "requester_id" : 1,
  "submitter_id" : 1,
  "assignee_id" : 1,
  "organization_id" : 1,
  "group_id" : 1,
  "collaborator_ids" : [ 1 ],
  "follower_ids" : [ 1 ],
  "email_cc_ids" : [ ],
  "forum_topic_ids" : [ ],
  "problem_id" : 1,
  "has_incidents" : false,
  "is_public" : false,
  "due_at" : "",
  "tags" : [ "" ],
  "custom_fields" : [ {
    "id" : 1,
    "value" : ""
  } ],
  "satisfaction_rating" : {
    "comment" : "",
    "id" : 1,
    "score" : ""
  },
  "sharing_agreement_ids" : [ 1 ],
  "custom_status_id" : 1,
  "encoded_id" : "",
  "fields" : [ {
    "id" : 1,
    "value" : ""
  } ],
  "followup_ids" : [ ],
  "ticket_form_id" : 1,
  "brand_id" : 1,
  "allow_channelback" : false,
  "allow_attachments" : false,
  "from_messaging_channel" : false
}

Create Organization

Name: createOrganization

Creates an organization.

Properties

Name	Label	Type	Description	Required
name	Name	STRING	Name of the organization.	true
details	Details	STRING	Any details about the organization, such as the address.	false
domain_names	Domain Names	ARRAY Items [STRING($domain_name)]	An array of domain names associated with this organization.	true
notes	Notes	STRING	Any notes you have about the organization.	false

Example JSON Structure

{
  "label" : "Create Organization",
  "name" : "createOrganization",
  "parameters" : {
    "name" : "",
    "details" : "",
    "domain_names" : [ "" ],
    "notes" : ""
  },
  "type" : "zendesk/v1/createOrganization"
}

Properties

Name	Type	Description
url	STRING	URL of the created organization.
id	STRING	Organization ID.
name	STRING	Organization name.
shared_tickets	BOOLEAN Options true, false	Whether the organization can share tickets.
shared_comments	BOOLEAN Options true, false	Whether the organization can share comments.
external_id	INTEGER	External ID of the organization.
created_at	STRING	Date when the organization was created.
updated_at	STRING	Date when the organization was last updated.
domain_names	ARRAY Items [STRING]	Array of domain names of the organization.
detail	STRING	Details about the organization.
notes	STRING	Notes about the organization.
group_id	INTEGER	Group ID of the organization.
tags	ARRAY Items [STRING]	Tags of the organization.
organization_fields	OBJECT Properties {}	Custom organization fields of the organization.

Output Example

{
  "url" : "",
  "id" : "",
  "name" : "",
  "shared_tickets" : false,
  "shared_comments" : false,
  "external_id" : 1,
  "created_at" : "",
  "updated_at" : "",
  "domain_names" : [ "" ],
  "detail" : "",
  "notes" : "",
  "group_id" : 1,
  "tags" : [ "" ],
  "organization_fields" : { }
}

Create Ticket

Name: createTicket

Creates a ticket.

Properties

Name	Label	Type	Description	Required
subject	Subject	STRING	Subject of the ticket.	false
type	Type	STRING Options problem, incident, question, task	Type of the ticket.	false
comment	Comment	STRING	Comment of the ticket.	true
priority	Priority	STRING Options low, normal, high, urgent	Priority of the ticket.	false
status	Status	STRING Options new, open, pending, hold, solved, closed	Status of the ticket.	false

Example JSON Structure

{
  "label" : "Create Ticket",
  "name" : "createTicket",
  "parameters" : {
    "subject" : "",
    "type" : "",
    "comment" : "",
    "priority" : "",
    "status" : ""
  },
  "type" : "zendesk/v1/createTicket"
}

Properties

Name	Type	Description
url	STRING	API URL of the ticket resource.
id	INTEGER	Ticket ID.
external_id	INTEGER	External ID of the ticket.
via	OBJECT Properties {STRING(channel), {{}(from), {}(to), {}(rel)}(source)}	Information for how the ticket was created.
created_at	STRING	Timestamp when the ticket was created.
updated_at	STRING	Timestamp of the last update to the ticket.
generated_timestamp	INTEGER	UNIX timestamp when the ticket was generated.
type	STRING	Type of the ticket.
subject	STRING	Subject line of the ticket.
raw_subject	STRING	Unprocessed subject line of the ticket.
description	STRING	Detailed description of the ticket issue.
priority	STRING	Priority of the ticket.
status	STRING	Current status of the ticket.
recipient	STRING	Email address of the ticket recipient.
requester_id	INTEGER	ID of the user who requested the ticket.
submitter_id	INTEGER	ID of the user who submitted the ticket.
assignee_id	INTEGER	ID of the agent assigned to the ticket.
organization_id	INTEGER	ID of the organization associated with the requester.
group_id	INTEGER	ID of the group associated with the ticket.
collaborator_ids	ARRAY Items [INTEGER]	List of user IDs who are collaborators on the ticket.
follower_ids	ARRAY Items [INTEGER]	List of user IDs following the ticket.
email_cc_ids	ARRAY Items []	List of ticket CCs user IDs.
forum_topic_ids	ARRAY Items []	List of forum ID topics.
problem_id	INTEGER	ID of the problem the ticket is linked to.
has_incidents	BOOLEAN Options true, false	Whether the ticket has related incidents.
is_public	BOOLEAN Options true, false	Whether the ticket is public.
due_at	STRING	Due date for the ticket, if any.
tags	ARRAY Items [STRING]	List of tags associated with the ticket.
custom_fields	ARRAY Items [{INTEGER(id), STRING(value)}]	Custom field values associated with the ticket.
satisfaction_rating	OBJECT Properties {STRING(comment), INTEGER(id), STRING(score)}	Customer satisfaction rating for the ticket.
sharing_agreement_ids	ARRAY Items [INTEGER($id)]	List of sharing agreement IDs for the ticket.
custom_status_id	INTEGER	Custom status ID for the ticket.
encoded_id	STRING	Encoded ticket ID.
fields	ARRAY Items [{INTEGER(id), STRING(value)}($item)]	Ticket fields.
followup_ids	ARRAY Items []	Array of follow up IDs.
ticket_form_id	INTEGER	Ticket form ID.
brand_id	INTEGER	Brand ID.
allow_channelback	BOOLEAN Options true, false	Whether channelback is allowed for the ticket.
allow_attachments	BOOLEAN Options true, false	Whether attachments are allowed for the ticket.
from_messaging_channel	BOOLEAN Options true, false	Indicates if the ticket originated from a messaging channel.

Output Example

{
  "url" : "",
  "id" : 1,
  "external_id" : 1,
  "via" : {
    "channel" : "",
    "source" : {
      "from" : { },
      "to" : { },
      "rel" : { }
    }
  },
  "created_at" : "",
  "updated_at" : "",
  "generated_timestamp" : 1,
  "type" : "",
  "subject" : "",
  "raw_subject" : "",
  "description" : "",
  "priority" : "",
  "status" : "",
  "recipient" : "",
  "requester_id" : 1,
  "submitter_id" : 1,
  "assignee_id" : 1,
  "organization_id" : 1,
  "group_id" : 1,
  "collaborator_ids" : [ 1 ],
  "follower_ids" : [ 1 ],
  "email_cc_ids" : [ ],
  "forum_topic_ids" : [ ],
  "problem_id" : 1,
  "has_incidents" : false,
  "is_public" : false,
  "due_at" : "",
  "tags" : [ "" ],
  "custom_fields" : [ {
    "id" : 1,
    "value" : ""
  } ],
  "satisfaction_rating" : {
    "comment" : "",
    "id" : 1,
    "score" : ""
  },
  "sharing_agreement_ids" : [ 1 ],
  "custom_status_id" : 1,
  "encoded_id" : "",
  "fields" : [ {
    "id" : 1,
    "value" : ""
  } ],
  "followup_ids" : [ ],
  "ticket_form_id" : 1,
  "brand_id" : 1,
  "allow_channelback" : false,
  "allow_attachments" : false,
  "from_messaging_channel" : false
}

Triggers

New Ticket

Name: newTicket

Triggers when a new ticket is submitted.

Type: DYNAMIC_WEBHOOK

Properties

Name	Label	Type	Description	Required
name	Webhook Name	STRING	Name of the webhook.	true

Properties

Name	Type	Description
actor_id	STRING	ID of the actor that triggered the webhook.
assignee_id	STRING	ID of the agent assigned to the ticket.
brand_id	STRING	Brand ID.
created_at	STRING	Timestamp when the ticket was created.
custom_status	INTEGER	Custom status of the ticket.
description	STRING	Detailed description of the ticket issue.
external_id	STRING	External ID of the ticket.
form_id	STRING	Form ID.
group_id	STRING	ID of the group associated with the ticket.
id	STRING	Ticket ID.
is_public	BOOLEAN Options true, false	Whether the ticket is public.
organization_id	STRING	ID of the organization associated with the requester.
priority	STRING	Priority of the ticket.
requester_id	STRING	ID of the user who requested the ticket.
status	STRING	Current status of the ticket.
subject	STRING	Subject line of the ticket.
submitter_id	STRING	ID of the user who submitted the ticket.
tags	ARRAY Items [STRING]	List of tags associated with the ticket.
type	STRING	Type of the ticket.
updated_at	STRING	Timestamp of the last update to the ticket.
via	OBJECT Properties {STRING(channel), {{}(from), {}(to), {}(rel)}(source)}	Information for how the ticket was created.

JSON Example

{
  "label" : "New Ticket",
  "name" : "newTicket",
  "parameters" : {
    "name" : ""
  },
  "type" : "zendesk/v1/newTicket"
}

What to do if your action is not listed here?

If this component doesn't have the action you need, you can use Custom Action to create your own. Custom Actions empower you to define HTTP requests tailored to your specific requirements, allowing for greater flexibility in integrating with external services or APIs.

To create a Custom Action, simply specify the desired HTTP method, path, and any necessary parameters. This way, you can extend the functionality of your component beyond the predefined actions, ensuring that you can meet all your integration needs effectively.

Additional instructions

Connection Setup

Create API Token

Go to your Zendesk dashboard.
Click this icon.
Click on Apps and integrations.
Click on API configuration.
Enable API token access.
Click on Save.
Click on API tokens.
Click on Add API token.
Enter description of the token.
Click on Save.
Click on Copy.
Click on Save.
Done 🚀

Zendesk

On this page