List Triggers
GET {{baseUrl}}/api/v2/triggers?active=<boolean>&sort_by=<string>&sort_order=<string>&category_id=<string>
Lists all triggers for the current account.
Pagination
- Cursor pagination (recommended)
- Offset pagination
See Pagination.
Returns a maximum of 100 records per page.
Allowed For
- Agents
Sideloads
The following sideloads are supported. The usage sideloads are only supported on the Support Professional or Suite Growth plan or above.
| Name | Will sideload |
|---|---|
| app_installation | The app installation that requires each trigger, if present |
| permissions | The permissions for each trigger |
| usage_1h | The number of times each trigger has been used in the past hour |
| usage_24h | The number of times each trigger has been used in the past day |
| usage_7d | The number of times each trigger has been used in the past week |
| usage_30d | The number of times each trigger has been used in the past thirty days |
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
active | string | Filter by active triggers if true or inactive triggers if false | |
sort_by | string | Possible values are "alphabetical", "created_at", "updated_at", "usage_1h", "usage_24h", or "usage_7d". Defaults to "position" | |
sort_order | string | One of "asc" or "desc". Defaults to "asc" for alphabetical and position sort, "desc" for all others | |
category_id | string | Filter triggers by category ID |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"count":2,"next_page":null,"previous_page":null,"triggers":[{"actions":[],"active":true,"conditions":{},"created_at":"2012-09-25T22:50:26Z","description":"Close and save a ticket","id":25,"position":8,"raw_title":"Close and Save","title":"Close and Save","updated_at":"2012-09-25T22:50:26Z","url":"http://{subdomain}.zendesk.com/api/v2/triggers/25.json"},{"actions":[],"active":false,"conditions":{"all":[{"field":"status","operator":"less_than","value":"solved"},{"field":"assignee_id","operator":"is","value":"296220096"}],"any":[{"field":"status","operator":"less_than","value":"solved"},{"field":"custom_status_id","operator":"includes","value":["1","2"]}]},"created_at":"2012-09-25T22:50:26Z","description":"Assign a ticket with a priority tag","id":26,"position":9,"raw_title":"{{dc.assign_priority_tag}}","title":"Assign priority tag","updated_at":"2012-09-25T22:50:26Z","url":"http://{subdomain}.zendesk.com/api/v2/triggers/26.json"}]}