Zendesk Component

Manage Tickets and users in Zendesk

Component key: zendesk

Description

Zendesk is a public company headquartered in San Francisco, California. It provides software-as-a-service products related to customer support, sales, and other customer communications. The Zendesk component allows you to manage Users and Tickets inside your Zendesk domain.

Authorization Notes

The Zendesk component authenticates requests with OAuth 2.0. To configure an application inside zendesk follow the directions in this guide Now, you will have to configure OAuth 2.0 settings in Prismatic. Create a new credential of type OAuth 2.0 - Authorization Code.

• For Client ID enter in the unique identifier of your app inside the Zendesk admin dashboard. For Client Secret enter the generated client secret you received from the Zendesk admin dashboard.
• For Scopes refer to the guide that was linked above. There is detailed information on picking the correct scope.
• For Authorization URL enter https://{subdomain}.zendesk.com/oauth/authorizations/new
• For Access Token URL enter https://{subdomain}.zendesk.com/oauth/tokens

You can find your subdomain inside of your Zendesk URL: https://{YOUR SUBDOMAIN HERE}.zendesk.com/

Actions

Create Ticket

Create a new ticket | key: createTicket

Input	Key	Notes	Example
Assignee Id string	assigneeId	Provide a valid user id for the assignee of the ticket.	403598029853443232
Followers string	followers	For each item provide a unique identifier of the follower you want to add to the issue.	488042375842
Recipient Email string	recipientEmail	Provide a string value for the name of the recipient.	Jane.Doe@example-prismatic.io
Requester Email string / Required	requesterEmail	Provide a string value for the email of the requester.	John.Doe@example-email.com
Requester Name string / Required	requesterName	provide a string value for the name of the requester.	John Doe
Requester Organization Id string	requesterOrganization	Provide an integer value to specify the Organiation of the requester.	488042375842
Subdomain string / Required	subdomain	Provide a string value for the subdomain that your site lives in. You can find your subdomain in your zendesk URL https://<SUBDOMAIN>.zendesk.com/admin/home	prismaticExample
Tags string	tags	For each item, provide a string value for the tag.	Engineering
Ticket Comment string / Required	ticketComment	When creating a ticket, this field can be used to give a ticket description. It will also leave a comment on the ticket from the assignee.	This is an example Comment.
Ticket Priority string	ticketPriority	Provide a string value for the priority of the ticket.
Ticket Status string	ticketStatus	Provide a string value for the status of the ticket.
Ticket Subject string	ticketSubject	Provide a string value for the subject of the ticket	This is an example ticket subject.
Ticket Type string	ticketType	Provide a string value for the type of the ticket.

Authorization

Authorization is required for this action.

Auth Type	Key	Description	Fields
OAuth 2.0 - Authorization Code	oauth2	OAuth 2.0 authorization using the authorization code grant type	Client ID |  client_id Client Secret |  client_secret Scopes |  scopes Authorization URL |  auth_uri Access Token URL |  token_uri

---

Create User

Create a new user | key: createUser

Input	Key	Notes	Example
Moderator boolean	isModerator	This flag specifies whether or not the user will have moderator permissions.
Verified boolean	isVerified	Flip this flag to true if any of the user's identities is verified.
Organization Id string	organizationId	Provide the unique identifier of the organization.
Subdomain string / Required	subdomain	Provide a string value for the subdomain that your site lives in. You can find your subdomain in your zendesk URL https://<SUBDOMAIN>.zendesk.com/admin/home	prismaticExample
Alias string	userAlias	Provide a string value that represents an alias to give to a user.	Example Alias
Details string	userDetails	Provide a string value that represents details to be attached to the user.	These are some example user details
Email Address string / Required	userEmail	Provide a valid email address for the user. Make sure this value does not conflict with any other users in your Zendesk Domain	someone@example-prismatic.io
Name string / Required	userName	Provide a string value for the name of the user.	John Doe
Notes string	userNotes	Provide a string value that represents notes to be attached to the user.	These are some example notes.
Phone Number string	userPhone	Provide a valid phone number for the user.	15554008989
User Role string	userRole	Provide which level of permissions the user is granted.

Authorization

Authorization is required for this action.

Auth Type	Key	Description	Fields
OAuth 2.0 - Authorization Code	oauth2	OAuth 2.0 authorization using the authorization code grant type	Client ID |  client_id Client Secret |  client_secret Scopes |  scopes Authorization URL |  auth_uri Access Token URL |  token_uri

---

Delete Ticket

Delete the information and metadata of a ticket by Id | key: deleteTicket

Input	Key	Notes	Example
Subdomain string / Required	subdomain	Provide a string value for the subdomain that your site lives in. You can find your subdomain in your zendesk URL https://<SUBDOMAIN>.zendesk.com/admin/home	prismaticExample
Ticket Id string / Required	ticketId	Provide the unique identifier for the ticket you would like to show.	ExampleTicketId

Authorization

Authorization is required for this action.

Auth Type	Key	Description	Fields
OAuth 2.0 - Authorization Code	oauth2	OAuth 2.0 authorization using the authorization code grant type	Client ID |  client_id Client Secret |  client_secret Scopes |  scopes Authorization URL |  auth_uri Access Token URL |  token_uri

---

Delete User

Delete the information and metadata of a user by Id | key: deleteUser

Input	Key	Notes	Example
Subdomain string / Required	subdomain	Provide a string value for the subdomain that your site lives in. You can find your subdomain in your zendesk URL https://<SUBDOMAIN>.zendesk.com/admin/home	prismaticExample
UserId string	userId	Provide an integer value for the unique identifier of the user.	488042375842

Authorization

Authorization is required for this action.

Auth Type	Key	Description	Fields
OAuth 2.0 - Authorization Code	oauth2	OAuth 2.0 authorization using the authorization code grant type	Client ID |  client_id Client Secret |  client_secret Scopes |  scopes Authorization URL |  auth_uri Access Token URL |  token_uri

---

List Tickets

List all Tickets | key: listTickets

Input	Key	Notes	Example
Subdomain string / Required	subdomain	Provide a string value for the subdomain that your site lives in. You can find your subdomain in your zendesk URL https://<SUBDOMAIN>.zendesk.com/admin/home	prismaticExample

Authorization

Authorization is required for this action.

Auth Type	Key	Description	Fields
OAuth 2.0 - Authorization Code	oauth2	OAuth 2.0 authorization using the authorization code grant type	Client ID |  client_id Client Secret |  client_secret Scopes |  scopes Authorization URL |  auth_uri Access Token URL |  token_uri

---

List Tickets Assigned To User

List all of the tickets that have been assigned to a particular user | key: listTicketsToUser

Input	Key	Notes	Example
Subdomain string / Required	subdomain	Provide a string value for the subdomain that your site lives in. You can find your subdomain in your zendesk URL https://<SUBDOMAIN>.zendesk.com/admin/home	prismaticExample
UserId string	userId	Provide an integer value for the unique identifier of the user.	488042375842

Authorization

Authorization is required for this action.

Auth Type	Key	Description	Fields
OAuth 2.0 - Authorization Code	oauth2	OAuth 2.0 authorization using the authorization code grant type	Client ID |  client_id Client Secret |  client_secret Scopes |  scopes Authorization URL |  auth_uri Access Token URL |  token_uri

Output Example Payload

{  "data": {    "tickets": [],    "count": 5,    "next_page": 5,    "previous_page": 5  }}

---

List Tickets Requested By User

List all of the tickets that a particular user has requested | key: listTicketsByUser

Input	Key	Notes	Example
Subdomain string / Required	subdomain	Provide a string value for the subdomain that your site lives in. You can find your subdomain in your zendesk URL https://<SUBDOMAIN>.zendesk.com/admin/home	prismaticExample
UserId string	userId	Provide an integer value for the unique identifier of the user.	488042375842

Authorization

Authorization is required for this action.

Auth Type	Key	Description	Fields
OAuth 2.0 - Authorization Code	oauth2	OAuth 2.0 authorization using the authorization code grant type	Client ID |  client_id Client Secret |  client_secret Scopes |  scopes Authorization URL |  auth_uri Access Token URL |  token_uri

Output Example Payload

{  "data": {    "tickets": [],    "count": 5,    "next_page": 5,    "previous_page": 5  }}

---

List Users

List all Users | key: listUsers

Input	Key	Notes	Example
Subdomain string / Required	subdomain	Provide a string value for the subdomain that your site lives in. You can find your subdomain in your zendesk URL https://<SUBDOMAIN>.zendesk.com/admin/home	prismaticExample

Authorization

Authorization is required for this action.

Auth Type	Key	Description	Fields
OAuth 2.0 - Authorization Code	oauth2	OAuth 2.0 authorization using the authorization code grant type	Client ID |  client_id Client Secret |  client_secret Scopes |  scopes Authorization URL |  auth_uri Access Token URL |  token_uri

Output Example Payload

{  "data": {    "users": [],    "count": 5,    "next_page": 5,    "previous_page": 5  }}

---

Show Ticket

Get the information and metadata of a ticket by Id | key: showTicket

Input	Key	Notes	Example
Subdomain string / Required	subdomain	Provide a string value for the subdomain that your site lives in. You can find your subdomain in your zendesk URL https://<SUBDOMAIN>.zendesk.com/admin/home	prismaticExample
Ticket Id string / Required	ticketId	Provide the unique identifier for the ticket you would like to show.	ExampleTicketId

Authorization

Authorization is required for this action.

Auth Type	Key	Description	Fields
OAuth 2.0 - Authorization Code	oauth2	OAuth 2.0 authorization using the authorization code grant type	Client ID |  client_id Client Secret |  client_secret Scopes |  scopes Authorization URL |  auth_uri Access Token URL |  token_uri

---

Show User

Get the information and metadata of a user by Id | key: showUser

Input	Key	Notes	Example
Subdomain string / Required	subdomain	Provide a string value for the subdomain that your site lives in. You can find your subdomain in your zendesk URL https://<SUBDOMAIN>.zendesk.com/admin/home	prismaticExample
UserId string	userId	Provide an integer value for the unique identifier of the user.	488042375842

Authorization

Authorization is required for this action.

Auth Type	Key	Description	Fields
OAuth 2.0 - Authorization Code	oauth2	OAuth 2.0 authorization using the authorization code grant type	Client ID |  client_id Client Secret |  client_secret Scopes |  scopes Authorization URL |  auth_uri Access Token URL |  token_uri

---

Update Ticket

Update the information and metadata of a ticket by Id | key: updateTicket

Input	Key	Notes	Example
Assignee Email string	assigneeEmail	Provide a valid email for the assignee of the ticket.	Jane.Doe@example-prismatic.io
Assignee Id string	assigneeId	Provide a valid user id for the assignee of the ticket.	403598029853443232
Requester Organization Id string	requesterOrganization	Provide an integer value to specify the Organiation of the requester.	488042375842
Subdomain string / Required	subdomain	Provide a string value for the subdomain that your site lives in. You can find your subdomain in your zendesk URL https://<SUBDOMAIN>.zendesk.com/admin/home	prismaticExample
Tags string	tags	For each item, provide a string value for the tag.	Engineering
Ticket Comment string	ticketComment	When creating a ticket, this field can be used to give a ticket description. It will also leave a comment on the ticket from the assignee.	This is an example Comment.
Ticket Id string / Required	ticketId	Provide the unique identifier for the ticket you would like to show.	ExampleTicketId
Ticket Priority string	ticketPriority	Provide a string value for the priority of the ticket.
Ticket Status string	ticketStatus	Provide a string value for the status of the ticket.
Ticket Subject string	ticketSubject	Provide a string value for the subject of the ticket	This is an example ticket subject.
Ticket Type string	ticketType	Provide a string value for the type of the ticket.

Authorization

Authorization is required for this action.

Auth Type	Key	Description	Fields
OAuth 2.0 - Authorization Code	oauth2	OAuth 2.0 authorization using the authorization code grant type	Client ID |  client_id Client Secret |  client_secret Scopes |  scopes Authorization URL |  auth_uri Access Token URL |  token_uri

---

Update User

Update the information and metadata of a user by Id | key: updateUser

Input	Key	Notes	Example
Moderator boolean	isModerator	This flag specifies whether or not the user will have moderator permissions.
Verified boolean	isVerified	Flip this flag to true if any of the user's identities is verified.
Organization Id string	organizationId	Provide the unique identifier of the organization.
Subdomain string / Required	subdomain	Provide a string value for the subdomain that your site lives in. You can find your subdomain in your zendesk URL https://<SUBDOMAIN>.zendesk.com/admin/home	prismaticExample
Alias string	userAlias	Provide a string value that represents an alias to give to a user.	Example Alias
Details string	userDetails	Provide a string value that represents details to be attached to the user.	These are some example user details
Email Address string	userEmail	Provide a valid email address for the user. Make sure this value does not conflict with any other users in your Zendesk Domain	someone@example-prismatic.io
UserId string / Required	userId	Provide an integer value for the unique identifier of the user.	488042375842
Name string	userName	Provide a string value for the name of the user.	John Doe
Notes string	userNotes	Provide a string value that represents notes to be attached to the user.	These are some example notes.
Phone Number string	userPhone	Provide a valid phone number for the user.	15554008989
User Role string	userRole	Provide which level of permissions the user is granted.
Time Zone string	userTimeZone	Provide a valid timezone that the user operates in.	Berlin

Updating a user's 'User Role' from a end-user to administrator may cause a failed execution. For more information refer to the user permissions guide in the Zendesk docs.

Authorization

Authorization is required for this action.

Auth Type	Key	Description	Fields
OAuth 2.0 - Authorization Code	oauth2	OAuth 2.0 authorization using the authorization code grant type	Client ID |  client_id Client Secret |  client_secret Scopes |  scopes Authorization URL |  auth_uri Access Token URL |  token_uri

---