GET /api/v2/custom_objects/{custom_object_key}/triggers/search
Returns a list of object triggers that meet your filter or search criteria.
Pagination
- Offset pagination only
See Using Offset Pagination.
Allowed For
- Agents
Filter
Use the filter query parameter to filter an object trigger search by one or more attributes. For example, the following filter argument filters object triggers by the title attribute:
{
"json": {
"title": "test"
}
}
Servers
- https://{subdomain}.{domain}.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
custom_object_key |
String | Yes |
The key of a custom object |
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.