Zendesk

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

Connection Setup

Create API Token

Login to your Zendesk dashboard.
Click on Support.
Click on Admin center.
Click on Apps and integrations.
Click on API configuration.
Enable Allow password access for end users and Allow API token access.
Click on Save.
Click on API tokens.
Click on Add API token.
Enter token name.
Click on Save.
Click on Copy.
Click on Save.
Done 🚀

Actions

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

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
}

Create User

Name: createUser

Creates a user.

Properties

Name	Label	Type	Description	Required
name	Name	STRING	The name of the user.	true
email	Email	STRING	The email address of the user.	true
role	Role	STRING Options admin, agent, end-user	The role that will be assigned to new user.	false
skip_verify_email	Skip Verify Email	BOOLEAN Options true, false	Whether a verification mail will be sent to the new user.	false

Example JSON Structure

{
  "label" : "Create User",
  "name" : "createUser",
  "parameters" : {
    "name" : "",
    "email" : "",
    "role" : "",
    "skip_verify_email" : false
  },
  "type" : "zendesk/v1/createUser"
}

Properties

Name	Type	Description
id	INTEGER	Automatically assigned when the user is created
url	STRING	The user's API url
name	STRING	The user's name
email	STRING	The user's primary email address. *Writeable on create only. On update, a secondary email is added. See Email Address
created_at	STRING	The time the user was created
updated_at	STRING	The time the user was last updated
time_zone	STRING	The user's time zone. See Time Zone
iana_time_zone	STRING	The time zone for the user
phone	STRING	The user's primary phone number. See Phone Number below
shared_phone_number	BOOLEAN Options true, false	Whether the phone number is shared or not. See Phone Number below
photo	OBJECT Properties {}	The user's profile picture represented as an Attachment object
locale_id	INTEGER	The user's language identifier
locale	STRING	The user's locale. A BCP-47 compliant tag for the locale. If both "locale" and "locale_id" are present on create or update, "locale_id" is ignored and only "locale" is used.
organization_id	INTEGER	The id of the user's organization. If the user has more than one organization memberships, the id of the user's default organization. If updating, see Organization ID
role	STRING	The user's role. Possible values are "end-user", "agent", or "admin"
verified	BOOLEAN Options true, false	Any of the user's identities is verified. See User Identities
last_active	STRING	Last time the user was active.
external_id	STRING	A unique identifier from another system. The API treats the id as case insensitive. Example: "ian1" and "IAN1" are the same value.
tags	ARRAY Items [STRING]	The user's tags. Only present if your account has user tagging enabled
alias	STRING	An alias displayed to end users
active	BOOLEAN Options true, false	false if the user has been deleted
shared	BOOLEAN Options true, false	If the user is shared from a different Zendesk Support instance. Shared users can be added to organizations but cannot be modified through update requests. Any attempt to update a shared user results in a 403 Forbidden error. Ticket sharing accounts only
shared_agent	BOOLEAN Options true, false	If the user is a shared agent from a different Zendesk Support instance. Ticket sharing accounts only
last_login_at	STRING	Last time the user signed in to Zendesk Support or made an API request using an API token
two_factor_auth_enabled	BOOLEAN Options true, false	If two factor authentication is enabled
signature	STRING	The user's signature. Only agents and admins can have signatures
details	STRING	Any details you want to store about the user, such as an address
notes	STRING	Any notes you want to store about the user
role_type	INTEGER	The user's role id. 0 for a custom agent, 1 for a light agent, 2 for a chat agent, 3 for a chat agent added to the Support account as a contributor (Chat Phase 4), 4 for an admin, and 5 for a billing admin
custom_role_id	INTEGER	A custom role if the user is an agent on the Enterprise plan or above
is_billing_admin	BOOLEAN Options true, false	Whether the user is a billing admin.
moderator	BOOLEAN Options true, false	Designates whether the user has forum moderation capabilities
ticket_restriction	STRING	Specifies which tickets the user has access to. Possible values are: "organization", "groups", "assigned", "requested", null. "groups" and "assigned" are valid only for agents. If you pass an invalid value to an end user (for example, "groups"), they will be assigned to "requested", regardless of their previous access
only_private_comments	BOOLEAN Options true, false	true if the user can only create private comments
restricted_agent	BOOLEAN Options true, false	If the agent has any restrictions; false for admins and unrestricted agents, true for other agents
suspended	BOOLEAN Options true, false	If the agent is suspended. Tickets from suspended users are also suspended, and these users cannot sign in to the end user portal
default_group_id	INTEGER	The id of the user's default group
report_csv	BOOLEAN Options true, false	This parameter is inert and has no effect. It may be deprecated in the future. Previously, this parameter determined whether a user could access a CSV report in a legacy Guide dashboard. This dashboard has been removed. See Announcing Guide legacy reporting upgrade to Explore
user_fields	OBJECT Properties {}	Values of custom fields in the user's profile. See User Fields
suspension_details	OBJECT Properties {}	Channel-level suspension state for the user. The value is null if the user has no active channel-level suspension

Output Example

{
  "id" : 1,
  "url" : "",
  "name" : "",
  "email" : "",
  "created_at" : "",
  "updated_at" : "",
  "time_zone" : "",
  "iana_time_zone" : "",
  "phone" : "",
  "shared_phone_number" : false,
  "photo" : { },
  "locale_id" : 1,
  "locale" : "",
  "organization_id" : 1,
  "role" : "",
  "verified" : false,
  "last_active" : "",
  "external_id" : "",
  "tags" : [ "" ],
  "alias" : "",
  "active" : false,
  "shared" : false,
  "shared_agent" : false,
  "last_login_at" : "",
  "two_factor_auth_enabled" : false,
  "signature" : "",
  "details" : "",
  "notes" : "",
  "role_type" : 1,
  "custom_role_id" : 1,
  "is_billing_admin" : false,
  "moderator" : false,
  "ticket_restriction" : "",
  "only_private_comments" : false,
  "restricted_agent" : false,
  "suspended" : false,
  "default_group_id" : 1,
  "report_csv" : false,
  "user_fields" : { },
  "suspension_details" : { }
}

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.

Connections

basic_auth

Properties

Connection Setup

Create API Token

Actions

Add Comment to Ticket

Properties

Example JSON Structure

Output

Properties

Output Example

Finding Your Ticket ID

Create Organization

Properties

Example JSON Structure

Output

Properties

Output Example

Create Ticket

Properties

Example JSON Structure

Output

Properties

Output Example

Create User

Properties

Example JSON Structure

Output

Properties

Output Example

Triggers

New Ticket

Properties

Output

Properties

JSON Example

What to do if your action is not listed here?

On this page