GET /api/v2/triggers/search
Pagination
- Offset pagination only
See Using Offset Pagination.
Allowed For
- Agents
Sideloads
The following sideloads are supported. For more information, see Side-loading.
| Name | Will sideload |
|---|---|
| app_installation | The app installation that requires each ticket trigger, if present |
| permissions | The permissions for each ticket trigger |
| usage_1h | The number of times each ticket trigger has been used in the past hour |
| usage_24h | The number of times each ticket trigger has been used in the past day |
| usage_7d | The number of times each ticket trigger has been used in the past week |
| usage_30d | The number of times each ticket trigger has been used in the past thirty days |
Filter
Use the filter query parameter to filter a ticket trigger search by one or more attributes. For example, the following filter argument filters ticket triggers by the description attribute:
{
"json": {
"description": "Close a ticket"
}
}
Servers
- https://{subdomain}.{domain}.com
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
query |
String | Yes |
Query string used to find all triggers with matching title |
sort_order |
String | No |
One of "asc" or "desc". Defaults to "asc" for alphabetical and position sort, "desc" for all others |
active |
Boolean | No |
Filter by active triggers if true or inactive triggers if false |
include |
String | No |
A sideload to include in the response. See Sideloads |
filter |
Object | No |
Trigger attribute filters for the search. See Filter |
sort |
String | No |
Cursor-based pagination only. Possible values are "alphabetical", "created_at", "updated_at", or "position". |
sort_by |
String | No |
Offset pagination only. Possible values are "alphabetical", "created_at", "updated_at", "usage_1h", "usage_24h", or "usage_7d". Defaults to "position" |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.