Zendesk Component
Manage Tickets and users in Zendesk
Component key: zendesk#
DescriptionZendesk 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.
#
Zendesk Connections#
Zendesk ConnectionThe 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 create a new Zendesk connection in Prismatic.
- 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.
You can find your subdomain inside of your Zendesk URL: https://{YOUR SUBDOMAIN HERE}.zendesk.com/
Input | Notes | Example |
---|---|---|
Input Authorize URL string / Required | Notes The OAuth 2.0 Authorization URL for Zendesk | Example https://YOUR-ZENDESK-DOMAIN.zendesk.com/oauth/authorizations/new |
Input Client ID string / Required | Notes | Example |
Input Client Secret password / Required | Notes | Example |
Input Scopes string / Required | Notes A space-delimited set of one or more scopes to get the user's permission to access. | Example read write |
Input Subdomain string / Required | Notes 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 | Example acmeInc |
Input Token URL string / Required | Notes The OAuth 2.0 Token URL for Zendesk | Example https://YOUR-ZENDESK-DOMAIN.zendesk.com/oauth/tokens |
#
Actions#
Create TicketCreate a new ticket | key: createTicket
Input | Default | Notes | Example |
---|---|---|---|
Input Assignee Id string | Default | Notes Provide a valid user id for the assignee of the ticket. | Example 403598029853443232 |
Input Debug boolean | Default false | Notes This flag toggles debugging. When true the integration will log any requests and failures. | Example |
Input Followers string Value List | Default | Notes For each item provide a unique identifier of the follower you want to add to the issue. | Example 488042375842 |
Input Recipient Email string | Default | Notes Provide a string value for the name of the recipient. | Example Jane.Doe@example-prismatic.io |
Input Requester Email string / Required | Default | Notes Provide a string value for the email of the requester. | Example John.Doe@example-email.com |
Input Requester Name string / Required | Default | Notes provide a string value for the name of the requester. | Example John Doe |
Input Requester Organization Id string | Default | Notes Provide an integer value to specify the Organization of the requester. | Example 488042375842 |
Input Tags string Value List | Default | Notes For each item, provide a string value for the tag. | Example Engineering |
Input Ticket Comment Body string | Default | Notes 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. | Example This is an example Comment. |
Input Ticket Comment HTML Body string | Default | Notes When creating a ticket, this field can be used to give a ticket description using HTML. It will also leave a comment on the ticket from the assignee. | Example <p>This is an example Comment.</p> |
Input Ticket Priority string | Default | Notes Provide a string value for the priority of the ticket. | Example |
Input Ticket Status string | Default | Notes Provide a string value for the status of the ticket. | Example |
Input Ticket Subject string | Default | Notes Provide a string value for the subject of the ticket | Example This is an example ticket subject. |
Input Ticket Type string | Default | Notes Provide a string value for the type of the ticket. | Example |
Input Connection connection / Required | Default | Notes | Example |
#
Create UserCreate a new user | key: createUser
Input | Default | Notes | Example |
---|---|---|---|
Input Debug boolean | Default false | Notes This flag toggles debugging. When true the integration will log any requests and failures. | Example |
Input Moderator boolean | Default | Notes This flag specifies whether or not the user will have moderator permissions. | Example |
Input Verified boolean | Default | Notes Flip this flag to true if any of the user's identities is verified. | Example |
Input Organization Id string | Default | Notes Provide the unique identifier of the organization. | Example |
Input Alias string | Default | Notes Provide a string value that represents an alias to give to a user. | Example Example Alias |
Input Details string | Default | Notes Provide a string value that represents details to be attached to the user. | Example These are some example user details |
Input Email Address string / Required | Default | Notes Provide a valid email address for the user. Make sure this value does not conflict with any other users in your Zendesk Domain | Example someone@example-prismatic.io |
Input Name string / Required | Default | Notes Provide a string value for the name of the user. | Example John Doe |
Input Notes string | Default | Notes Provide a string value that represents notes to be attached to the user. | Example These are some example notes. |
Input Phone Number string | Default | Notes Provide a valid phone number for the user. | Example 15554008989 |
Input User Role string | Default | Notes Provide which level of permissions the user is granted. | Example |
Input Connection connection / Required | Default | Notes | Example |
#
Delete TicketDelete the information and metadata of a ticket by Id | key: deleteTicket
Input | Default | Notes | Example |
---|---|---|---|
Input Debug boolean | Default false | Notes This flag toggles debugging. When true the integration will log any requests and failures. | Example |
Input Ticket Id string / Required | Default | Notes Provide the unique identifier for the ticket you would like to show. | Example ExampleTicketId |
Input Connection connection / Required | Default | Notes | Example |
#
Delete UserDelete the information and metadata of a user by Id | key: deleteUser
Input | Default | Notes | Example |
---|---|---|---|
Input Debug boolean | Default false | Notes This flag toggles debugging. When true the integration will log any requests and failures. | Example |
Input UserId string | Default | Notes Provide an integer value for the unique identifier of the user. | Example 488042375842 |
Input Connection connection / Required | Default | Notes | Example |
#
List TicketsList all Tickets | key: listTickets
Input | Default | Notes |
---|---|---|
Input Debug boolean | Default false | Notes This flag toggles debugging. When true the integration will log any requests and failures. |
Input Connection connection / Required | Default | Notes |
#
List Tickets Assigned To UserList all of the tickets that have been assigned to a particular user | key: listTicketsToUser
Input | Default | Notes | Example |
---|---|---|---|
Input Debug boolean | Default false | Notes This flag toggles debugging. When true the integration will log any requests and failures. | Example |
Input UserId string | Default | Notes Provide an integer value for the unique identifier of the user. | Example 488042375842 |
Input Connection connection / Required | Default | Notes | Example |
#
Output Example Payload{ "data": { "tickets": [], "count": 5, "next_page": 5, "previous_page": 5 }}
#
List Tickets Requested By UserList all of the tickets that a particular user has requested | key: listTicketsByUser
Input | Default | Notes | Example |
---|---|---|---|
Input Debug boolean | Default false | Notes This flag toggles debugging. When true the integration will log any requests and failures. | Example |
Input UserId string | Default | Notes Provide an integer value for the unique identifier of the user. | Example 488042375842 |
Input Connection connection / Required | Default | Notes | Example |
#
Output Example Payload{ "data": { "tickets": [], "count": 5, "next_page": 5, "previous_page": 5 }}
#
List UsersList all Users | key: listUsers
Input | Default | Notes |
---|---|---|
Input Debug boolean | Default false | Notes This flag toggles debugging. When true the integration will log any requests and failures. |
Input Connection connection / Required | Default | Notes |
#
Output Example Payload{ "data": { "users": [], "count": 5, "next_page": 5, "previous_page": 5 }}
#
Show TicketGet the information and metadata of a ticket by Id | key: showTicket
Input | Default | Notes | Example |
---|---|---|---|
Input Debug boolean | Default false | Notes This flag toggles debugging. When true the integration will log any requests and failures. | Example |
Input Ticket Id string / Required | Default | Notes Provide the unique identifier for the ticket you would like to show. | Example ExampleTicketId |
Input Connection connection / Required | Default | Notes | Example |
#
Show UserGet the information and metadata of a user by Id | key: showUser
Input | Default | Notes | Example |
---|---|---|---|
Input Debug boolean | Default false | Notes This flag toggles debugging. When true the integration will log any requests and failures. | Example |
Input UserId string | Default | Notes Provide an integer value for the unique identifier of the user. | Example 488042375842 |
Input Connection connection / Required | Default | Notes | Example |
#
Update TicketUpdate the information and metadata of a ticket by Id | key: updateTicket
Input | Default | Notes | Example |
---|---|---|---|
Input Assignee Email string | Default | Notes Provide a valid email for the assignee of the ticket. | Example Jane.Doe@example-prismatic.io |
Input Assignee Id string | Default | Notes Provide a valid user id for the assignee of the ticket. | Example 403598029853443232 |
Input Debug boolean | Default false | Notes This flag toggles debugging. When true the integration will log any requests and failures. | Example |
Input Requester Organization Id string | Default | Notes Provide an integer value to specify the Organization of the requester. | Example 488042375842 |
Input Tags string Value List | Default | Notes For each item, provide a string value for the tag. | Example Engineering |
Input Ticket Comment Body string | Default | Notes 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. | Example This is an example Comment. |
Input Ticket Comment HTML Body string | Default | Notes When creating a ticket, this field can be used to give a ticket description using HTML. It will also leave a comment on the ticket from the assignee. | Example <p>This is an example Comment.</p> |
Input Ticket Id string / Required | Default | Notes Provide the unique identifier for the ticket you would like to show. | Example ExampleTicketId |
Input Ticket Priority string | Default | Notes Provide a string value for the priority of the ticket. | Example |
Input Ticket Status string | Default | Notes Provide a string value for the status of the ticket. | Example |
Input Ticket Subject string | Default | Notes Provide a string value for the subject of the ticket | Example This is an example ticket subject. |
Input Ticket Type string | Default | Notes Provide a string value for the type of the ticket. | Example |
Input Connection connection / Required | Default | Notes | Example |
#
Update UserUpdate the information and metadata of a user by Id | key: updateUser
Input | Default | Notes | Example |
---|---|---|---|
Input Debug boolean | Default false | Notes This flag toggles debugging. When true the integration will log any requests and failures. | Example |
Input Moderator boolean | Default | Notes This flag specifies whether or not the user will have moderator permissions. | Example |
Input Verified boolean | Default | Notes Flip this flag to true if any of the user's identities is verified. | Example |
Input Organization Id string | Default | Notes Provide the unique identifier of the organization. | Example |
Input Alias string | Default | Notes Provide a string value that represents an alias to give to a user. | Example Example Alias |
Input Details string | Default | Notes Provide a string value that represents details to be attached to the user. | Example These are some example user details |
Input Email Address string | Default | Notes Provide a valid email address for the user. Make sure this value does not conflict with any other users in your Zendesk Domain | Example someone@example-prismatic.io |
Input UserId string / Required | Default | Notes Provide an integer value for the unique identifier of the user. | Example 488042375842 |
Input Name string | Default | Notes Provide a string value for the name of the user. | Example John Doe |
Input Notes string | Default | Notes Provide a string value that represents notes to be attached to the user. | Example These are some example notes. |
Input Phone Number string | Default | Notes Provide a valid phone number for the user. | Example 15554008989 |
Input User Role string | Default | Notes Provide which level of permissions the user is granted. | Example |
Input Time Zone string | Default | Notes Provide a valid timezone that the user operates in. | Example Berlin |
Input Connection connection / Required | Default | Notes | Example |
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.