Sign in
Triggers

List Ticket Triggers

Lists all ticket 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.

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
get/api/v2/triggers

Query parameters

activeboolean

Filter by active triggers if true or inactive triggers if false

sortstring

Cursor-based pagination only. Possible values are "alphabetical", "created_at", "updated_at", or "position".

sort_bystring

Offset pagination only. Possible values are "alphabetical", "created_at", "updated_at", "usage_1h", "usage_24h", or "usage_7d". Defaults to "position"

sort_orderstring

One of "asc" or "desc". Defaults to "asc" for alphabetical and position sort, "desc" for all others

category_idstring

Filter triggers by category ID

Response

Success response

countinteger
next_pagestring nullable
previous_pagestring nullable

Example response

{
  "triggers": [
    {
      "actions": [
        {}
      ],
      "active": true,
      "category_id": "10026",
      "conditions": {},
      "created_at": "2012-09-25T22:50:26Z",
      "default": false,
      "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"
    }
  ]
}

Changes