Get Tickets
Description
This step retrieves tickets from Zendesk based on filter criteria. You can search by keywords, status, or other ticket properties. The step returns the matching ticket data. Use this step in workflows that look up open tickets, collect ticket data for reporting, or feed ticket lists into subsequent steps for bulk processing.
Limitations:
• All ticket fields are not visible in the get ticket fields list.
• If you provide incorrect or invalid values in the lookup fields or custom lookup fields, the API does not throw an error.
• The tickets do not come in sequence.
• Update Ticket: Only those records are updated that are searched.
Reference: https://developer.zendesk.com/api-reference/ticketing/tickets/tickets/
Configurations
General Tab
| No. | Field Name | Description |
|---|---|---|
| 1 | Step Name | Name of the step. This name has to be unique in a single workflow. |
| Connection: | ||
| 2 | Base URL | Specify base URL of Zendesk server instance. For example, https://xxxx.zendesk.com for a cloud instance. Data type: String Mandatory |
| 3 | Access Token | Access token retrieved from OAuth token API call. |
| 4 | Test Connection | Click the button to test the connection, if it is available or not. |
Input Tab
| No. | Field Name | Description |
|---|---|---|
| 1 | Criteria Query | Fetch all Zendesk tickets matching the criteria query. For sample criteria queries, see Zendesk Search API. |
| 2 | Fetch Records Batch Size | Specify the batch size used by the step when fetching records. |
| 3 | Get Top N Records | Fetch the top N records matching the criteria query. |
Output Tab
| No. | Field Name | Description |
|---|---|---|
| 1 | JSON Output | Output field to hold the result of the successful plugin execution. Default label value for this field is JSONOutput. |