Zendesk Spoke
The Zendesk spoke provides actions to view and analyze meaningful usage data for Zendesk software subscriptions. Analyze usage for your Zendesk account to determine which licenses are stale so that you can reclaim these licenses and realize your potential savings.
Request apps on the Store
Visit the ServiceNow Store to view all the available apps, and for information about submitting requests to the store. For cumulative release notes information for all released apps, see the ServiceNow Store version history release notes.
Integration Hub subscription
This spoke requires an Integration Hub subscription. For more information, see Legal schedules - IntegrationHub overview.
Spoke version
Zendesk spoke v1.9.0 is the latest version.
Supported versions
This spoke was built for Zendesk version 11015, but may be compatible with later versions.
Spoke requirements
Zendesk admin account.
Spoke dependencies
If you’re having trouble installing the app, ensure that these dependent plugins are installed:
- ServiceNow Integration Hub Runtime (com.glide.hub.integration.runtime)
- ServiceNow Integration Hub Action Step - REST (com.glide.hub.action_step.rest)
- ServiceNow Integration Hub Action Template - Data Stream (com.glide.hub.action_type.datastream)
Note: Some of these plugins are licensable features and require appropriate licenses, if used outside the spoke implementation.
Spoke flows
The Zendesk spoke provides the Upsert Zendesk Tickets flow to check if a new ticket has been created in the Zendesk Ticket table or if an existing ticket has been updated, and accordingly synchronizes it in Zendesk. To customize a sample flow, copy it to a new application scope.
Spoke subflows
The Zendesk spoke provides sample subflows to demonstrate automating tasks. To customize the sample subflow, copy it to a new application scope. Available subflows include:
| Subflow | Description |
|---|---|
| Create Zendesk Webhook | Creates a webhook in Zendesk whene a request is received from the Webhook Registries [sn_zendesk_spoke_webhook_registries] table. |
| Process Zendesk Webhook | Inserts and updates records in the Zendesk Tickets table based on the changes happening in Zendesk. |
| Update Zendesk Webhook | Updates the webhook tokens and synchronizes them both in ServiceNow and Zendesk. |
Spoke actions
The Zendesk spoke provides actions to automate Zendesk tasks when events occurs in your ServiceNow instance. Available actions include:
| Category | Action | Description |
|---|---|---|
| Activity Management | Look up Activities Stream | Retrieves details of the ticket activities. Ticket activities include assigning a ticket to the agent, increasing the priority of a ticket assigned to the agent, or adding a comment to a ticket assigned to the agent. |
| Look up Activity by ID | Retrieves details of the specified ticket activity. Activities include assigning a ticket to the agent, increasing the priority of a ticket assigned to the agent, or adding a comment to a ticket assigned to the agent. | |
| Attachment Management | Look up Attachment by ID | Retrieves attachment details by value of the Attachment ID. |
| Upload Attachment | Uploads a file you want to attach. | |
| Group Management | Look up Group by ID | Retrieves information about the specified group. |
| Look up Groups Stream | Retrieves the list of all groups within an account. | |
| Organization Management | Look up Organization by ID | Retrieves information about the specified organization. |
| Look up Organizations Stream | Retrieves the list of all organizations. | |
| Request Management | Create Request | Creates a request by setting one or more properties. |
| Look up Comment by ID | Retrieves the comment added to the request corresponding to the Request ID and the Comment ID. | |
| Look up Comments by Request ID Stream | Retrieves the comments added to the request related to the Request ID that you sent through the input. | |
| Look up Request by ID | Retrieves the request details by value of the Request ID. | |
| Look up Requests by Organization ID Stream | Retrieves all the requests in an account corresponding to the Requester ID. | |
| Look up Requests by Requester ID Stream | Retrieves all the requests in an account corresponding to the Requester ID. | |
| Look up Requests Stream | Retrieves all the requests in an account based on the state of the request. | |
| Update Request by ID | Updates the request with a comment or collaborators \(cc's\). | |
| Role Management | Look up Custom Role by ID | Retrieves information about the specified custom role. |
| Look up Custom Roles | Retrieves the list of all custom roles within an enterprise account. | |
| Search | Search Entities by Parameter Stream | Retrieves all tickets, requests, and users in an account related to the query. |
| Search Requests by Keyword Stream | Retrieves all requests in an account related to the search string. | |
| Suspended Tickets Management | Delete Multiple Suspended Tickets by IDs | Deletes multiple suspended tickets. A list of suspended ticket IDs should be provided. |
| Delete Suspended Ticket by ID | Deletes a specific suspended ticket. | |
| Look up Suspended Ticket by ID | Searches for a specific suspended ticket by its ID. | |
| Look up Suspended Tickets Stream | Retrieves the details of suspended tickets. | |
| Recover Suspended Ticket by ID | Recovers the details of the specified suspended ticket. | |
| Ticket Audit | Look up Audit by ID | Retrieves the audit details of a ticket specific to an audit. |
| Look up Audit Log by ID | Retrieves the audit log details of a ticket specific to an audit. | |
| Look up Audit Logs Stream | Retrieves the audit log displaying the various changes in a Zendesk account since the account creation. | |
| Look up Audits Stream | Retrieves the list of audits for all the tickets. | |
| Look up Ticket Audits Stream | Retrieves the audits for the specified ticket. | |
| Update Audit as Private | Updates a comment from public to private for a ticket specific to an audit. | |
| Ticket Comment Management | Look up Comments by Ticket ID Stream | Retrieves the comments added to the specified ticket. |
| Ticket Management | Create Multiple Tickets | Creates multiple tickets with the provided details, at a time. |
| Create Ticket | Creates a ticket in the Zendesk instance. | |
| Create Ticket Async | Creates a ticket in the Zendesk instance. Ticket creation can sometimes take a while because of the complex business rules. Asynchronous creation enables you to get the response back quickly and queues a background job to do the actual work. | |
| Look up Job Status by ID | Retrieves the status record created when a user starts a job. | |
| Look up Multiple Tickets Stream | Retrieves details of multiple tickets. | |
| Look up Ticket by ID | Retrieves details of the specified ticket. | |
| Look up Tickets Stream | Retrieves the ticket properties. | |
| Recover Multiple Suspended Tickets by IDs | Recovers the specified suspended tickets. | |
| Update Multiple Tickets | Updates details of multiple tickets. | |
| Update Ticket | Updates the specified properties of a ticket. | |
| Ticket Metric Management | Look up Metric by ID | Retrieves a specific metric, or the required metrics of a ticket. |
| Look up Metrics by Ticket ID | Retrieves the metric details of the specified ticket. | |
| Look up Ticket Metric Events Stream | Retrieves the ticket metric events that occurred on or after the start time. | |
| Look up Tickets Metric Stream | Retrieves a list of tickets, along with their metrics. | |
| User Management | Delete User | Deletes the specified user and associated records from an account. Deleted users cannot be recovered. To comply with General Data Protection Regulation \(GDPR\), you must use the additional Permanently Delete User action to permanently delete the user after deleting the user. |
| Create User | Creates a user with the specified details. | |
| Look up Deleted Users Stream | Retrieves the list of all deleted users, including permanently deleted users, within an account. | |
| Look up User by ID | Retrieves the specified user’s details. | |
| Look up Users Stream | Retrieves the list of all users within an account. | |
| Permanently Delete User | Permanently deletes the specified user from an account.Before you can permanently delete the user, you must first delete the user using the Delete User action. | |
| Update User | Modifies details about the specified user. | |
| Webhook Management | Create Webhook | Creates a webhook with the provided details. |
| Delete Webhook | Deletes the specified webhook. | |
| Look up Webhook Details by ID | Retrieves details of the specified webhook. | |
| Look up Webhook Signing Secret by ID | Retrieves signing secret of the required webhook. | |
| Look up Webhooks Stream | Retrieves details of all the available webhooks. | |
| Reset Webhook Signing Secret by ID | Resets the signing secret of the specified webhook. | |
| Update Webhook | Updates details of the specified webhook. |
Note: This spoke has a Look up User action and Software Asset Management related actions only.
Integration Hub imports
The Zendesk spoke adds the Import Zendesk Users Integration Hub imports to your ServiceNow instance. The Integration Hub imports help you import the users' data from Zendesk account to your ServiceNow instance in an automated way. For more information about Integration Hub imports, seeIntegration Hub - Import.
Spoke modules
The Zendesk spoke adds the Zendesk Spoke application to your ServiceNow instance. The Zendesk Spoke application includes these modules:
| Module | Description |
|---|---|
| Users | Stores the details of the Zendesk users. These details are imported using the Import Zendesk Users Integration Hub imports. |
| Remote table | |
| Request | Retrieves and displayes the details of the requests raised by the specified requestor. For this, you must provide the value of Requester ID. |
| Webhook | |
| Webhook Registries | Stores the webhook registries. The webhook registries register a Zendesk webhook in ServiceNow to notify ServiceNow when certain events occur in Zendesk. |
| Routing Policies | Stores the details of the webhook. |
| Tickets | Stores detailf of the tickets created or updated in Zendesk. |
Connection and credential alias requirements
Integration Hub uses aliases to manage connection and credential information. Using an alias eliminates the need to configure multiple credentials and connection information profiles when using multiple environments. If the connection or credential information changes, you don't need to update any actions that use the connection. For more information, see Connections and Credentials.
For information about setting up the spoke, see Set up the Zendesk spoke.