List Active Triggers

GET {{baseUrl}}/api/v2/triggers/active?sort_by=<string>&sort_order=<string>&category_id=<string>

Lists all active triggers.

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:

NameWill sideload
app_installationThe app installation that requires each trigger, if present
permissionsThe permissions for each trigger
usage_1hThe number of times each trigger has been used in the past hour
usage_24hThe number of times each trigger has been used in the past day
usage_7dThe number of times each trigger has been used in the past week
usage_30dThe number of times each trigger has been used in the past thirty days

Request Params

KeyDatatypeRequiredDescription
sort_bystringPossible values are "alphabetical", "created_at", "updated_at", "usage_1h", "usage_24h", or "usage_7d". Defaults to "position"
sort_orderstringOne of "asc" or "desc". Defaults to "asc" for alphabetical and position sort, "desc" for all others
category_idstringFilter triggers by category ID

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{&quot;count&quot;:2,&quot;next_page&quot;:null,&quot;previous_page&quot;:null,&quot;triggers&quot;:[{&quot;actions&quot;:[],&quot;active&quot;:true,&quot;conditions&quot;:{},&quot;created_at&quot;:&quot;2012-09-25T22:50:26Z&quot;,&quot;description&quot;:&quot;Close and save a ticket&quot;,&quot;id&quot;:25,&quot;position&quot;:8,&quot;raw_title&quot;:&quot;Close and Save&quot;,&quot;title&quot;:&quot;Close and Save&quot;,&quot;updated_at&quot;:&quot;2012-09-25T22:50:26Z&quot;,&quot;url&quot;:&quot;http://{subdomain}.zendesk.com/api/v2/triggers/25.json&quot;},{&quot;actions&quot;:[],&quot;active&quot;:true,&quot;conditions&quot;:{&quot;all&quot;:[{&quot;field&quot;:&quot;status&quot;,&quot;operator&quot;:&quot;less_than&quot;,&quot;value&quot;:&quot;solved&quot;},{&quot;field&quot;:&quot;assignee_id&quot;,&quot;operator&quot;:&quot;is&quot;,&quot;value&quot;:&quot;296220096&quot;}],&quot;any&quot;:[{&quot;field&quot;:&quot;status&quot;,&quot;operator&quot;:&quot;less_than&quot;,&quot;value&quot;:&quot;solved&quot;}]},&quot;created_at&quot;:&quot;2012-09-25T22:50:26Z&quot;,&quot;description&quot;:&quot;Assign a ticket with a priority tag&quot;,&quot;id&quot;:26,&quot;position&quot;:9,&quot;raw_title&quot;:&quot;{{dc.assign_priority_tag}}&quot;,&quot;title&quot;:&quot;Assign priority tag&quot;,&quot;updated_at&quot;:&quot;2012-09-25T22:50:26Z&quot;,&quot;url&quot;:&quot;http://{subdomain}.zendesk.com/api/v2/triggers/26.json&quot;}]}