Skip to main content

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

InputKeyNotesExample

Assignee Id

string
assigneeIdProvide a valid user id for the assignee of the ticket.403598029853443232

Followers

string
followersFor each item provide a unique identifier of the follower you want to add to the issue.488042375842

Recipient Email

string
recipientEmailProvide a string value for the name of the recipient.Jane.Doe@example-prismatic.io

Requester Email

string
/ Required
requesterEmailProvide a string value for the email of the requester.John.Doe@example-email.com

Requester Name

string
/ Required
requesterNameprovide a string value for the name of the requester.John Doe

Requester Organization Id

string
requesterOrganizationProvide an integer value to specify the Organiation of the requester.488042375842

Subdomain

string
/ Required
subdomainProvide 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/homeprismaticExample

Tags

string
tagsFor each item, provide a string value for the tag.Engineering

Ticket Comment

string
/ Required
ticketCommentWhen 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
ticketPriorityProvide a string value for the priority of the ticket.

Ticket Status

string
ticketStatusProvide a string value for the status of the ticket.

Ticket Subject

string
ticketSubjectProvide a string value for the subject of the ticketThis is an example ticket subject.

Ticket Type

string
ticketTypeProvide a string value for the type of the ticket.

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 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

InputKeyNotesExample

Moderator

boolean
isModeratorThis flag specifies whether or not the user will have moderator permissions.

Verified

boolean
isVerifiedFlip this flag to true if any of the user's identities is verified.

Organization Id

string
organizationIdProvide the unique identifier of the organization.

Subdomain

string
/ Required
subdomainProvide 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/homeprismaticExample

Alias

string
userAliasProvide a string value that represents an alias to give to a user.Example Alias

Details

string
userDetailsProvide a string value that represents details to be attached to the user.These are some example user details

Email Address

string
/ Required
userEmailProvide a valid email address for the user. Make sure this value does not conflict with any other users in your Zendesk Domainsomeone@example-prismatic.io

Name

string
/ Required
userNameProvide a string value for the name of the user.John Doe

Notes

string
userNotesProvide a string value that represents notes to be attached to the user.These are some example notes.

Phone Number

string
userPhoneProvide a valid phone number for the user.15554008989

User Role

string
userRoleProvide which level of permissions the user is granted.

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 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

InputKeyNotesExample

Subdomain

string
/ Required
subdomainProvide 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/homeprismaticExample

Ticket Id

string
/ Required
ticketIdProvide the unique identifier for the ticket you would like to show.ExampleTicketId

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 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

InputKeyNotesExample

Subdomain

string
/ Required
subdomainProvide 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/homeprismaticExample

UserId

string
userIdProvide an integer value for the unique identifier of the user.488042375842

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 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

InputKeyNotesExample

Subdomain

string
/ Required
subdomainProvide 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/homeprismaticExample

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 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

InputKeyNotesExample

Subdomain

string
/ Required
subdomainProvide 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/homeprismaticExample

UserId

string
userIdProvide an integer value for the unique identifier of the user.488042375842

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 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

InputKeyNotesExample

Subdomain

string
/ Required
subdomainProvide 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/homeprismaticExample

UserId

string
userIdProvide an integer value for the unique identifier of the user.488042375842

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 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

InputKeyNotesExample

Subdomain

string
/ Required
subdomainProvide 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/homeprismaticExample

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 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

InputKeyNotesExample

Subdomain

string
/ Required
subdomainProvide 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/homeprismaticExample

Ticket Id

string
/ Required
ticketIdProvide the unique identifier for the ticket you would like to show.ExampleTicketId

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 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

InputKeyNotesExample

Subdomain

string
/ Required
subdomainProvide 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/homeprismaticExample

UserId

string
userIdProvide an integer value for the unique identifier of the user.488042375842

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 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

InputKeyNotesExample

Assignee Email

string
assigneeEmailProvide a valid email for the assignee of the ticket.Jane.Doe@example-prismatic.io

Assignee Id

string
assigneeIdProvide a valid user id for the assignee of the ticket.403598029853443232

Requester Organization Id

string
requesterOrganizationProvide an integer value to specify the Organiation of the requester.488042375842

Subdomain

string
/ Required
subdomainProvide 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/homeprismaticExample

Tags

string
tagsFor each item, provide a string value for the tag.Engineering

Ticket Comment

string
ticketCommentWhen 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
ticketIdProvide the unique identifier for the ticket you would like to show.ExampleTicketId

Ticket Priority

string
ticketPriorityProvide a string value for the priority of the ticket.

Ticket Status

string
ticketStatusProvide a string value for the status of the ticket.

Ticket Subject

string
ticketSubjectProvide a string value for the subject of the ticketThis is an example ticket subject.

Ticket Type

string
ticketTypeProvide a string value for the type of the ticket.

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 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

InputKeyNotesExample

Moderator

boolean
isModeratorThis flag specifies whether or not the user will have moderator permissions.

Verified

boolean
isVerifiedFlip this flag to true if any of the user's identities is verified.

Organization Id

string
organizationIdProvide the unique identifier of the organization.

Subdomain

string
/ Required
subdomainProvide 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/homeprismaticExample

Alias

string
userAliasProvide a string value that represents an alias to give to a user.Example Alias

Details

string
userDetailsProvide a string value that represents details to be attached to the user.These are some example user details

Email Address

string
userEmailProvide a valid email address for the user. Make sure this value does not conflict with any other users in your Zendesk Domainsomeone@example-prismatic.io

UserId

string
/ Required
userIdProvide an integer value for the unique identifier of the user.488042375842

Name

string
userNameProvide a string value for the name of the user.John Doe

Notes

string
userNotesProvide a string value that represents notes to be attached to the user.These are some example notes.

Phone Number

string
userPhoneProvide a valid phone number for the user.15554008989

User Role

string
userRoleProvide which level of permissions the user is granted.

Time Zone

string
userTimeZoneProvide 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 TypeKeyDescriptionFields
OAuth 2.0 - Authorization Codeoauth2OAuth 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