Unicode C++ / Support API / List Triggers
Back to Collection Items
void ChilkatSample(void)
{
http.put_BasicAuth(true); http.put_Login(L"login"); http.put_Password(L"password"); queryParams.UpdateString(L"active",L"<boolean>"); queryParams.UpdateString(L"sort_by",L"<string>"); queryParams.UpdateString(L"sort_order",L"<string>"); queryParams.UpdateString(L"category_id",L"<string>"); resp->GetBodySb(sbResponseBody); jResp.LoadSb(sbResponseBody); jResp.put_EmitCompact(false); jResp.put_I(i); title = jResp.stringOf(L"triggers[i].title"); active = jResp.stringOf(L"triggers[i].active"); category_id = jResp.stringOf(L"triggers[i].category_id"); created_at = jResp.stringOf(L"triggers[i].created_at"); default = jResp.stringOf(L"triggers[i].default"); description = jResp.stringOf(L"triggers[i].description"); id = jResp.stringOf(L"triggers[i].id"); position = jResp.stringOf(L"triggers[i].position"); raw_title = jResp.stringOf(L"triggers[i].raw_title"); updated_at = jResp.stringOf(L"triggers[i].updated_at"); url = jResp.stringOf(L"triggers[i].url"); j = 0; count_j = jResp.SizeOfArray(L"triggers[i].conditions.all"); jResp.put_J(j); field = jResp.stringOf(L"triggers[i].conditions.all[j].field"); operator = jResp.stringOf(L"triggers[i].conditions.all[j].operator"); value = jResp.stringOf(L"triggers[i].conditions.all[j].value"); j = j + 1; j = 0; count_j = jResp.SizeOfArray(L"triggers[i].conditions.any"); jResp.put_J(j); field = jResp.stringOf(L"triggers[i].conditions.any[j].field"); operator = jResp.stringOf(L"triggers[i].conditions.any[j].operator"); value = jResp.stringOf(L"triggers[i].conditions.any[j].value"); j = j + 1; j = 0; count_j = jResp.SizeOfArray(L"triggers[i].actions"); jResp.put_J(j); field = jResp.stringOf(L"triggers[i].actions[j].field"); value = jResp.stringOf(L"triggers[i].actions[j].value"); j = j + 1; i = i + 1;
}
Curl Command
curl -u login:password -G -d "active=%3Cboolean%3E"
-d "sort_by=%3Cstring%3E"
-d "sort_order=%3Cstring%3E"
-d "category_id=%3Cstring%3E"
-H "Accept: application/json"
https://example.zendesk.com/api/v2/triggers
Postman Collection Item JSON
{
"name": "List Triggers",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/triggers?active=<boolean>&sort_by=<string>&sort_order=<string>&category_id=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"triggers"
],
"query": [
{
"key": "active",
"value": "<boolean>",
"description": "Filter by active triggers if true or inactive triggers if false"
},
{
"key": "sort_by",
"value": "<string>",
"description": "Possible values are \"alphabetical\", \"created_at\", \"updated_at\", \"usage_1h\", \"usage_24h\", or \"usage_7d\". Defaults to \"position\""
},
{
"key": "sort_order",
"value": "<string>",
"description": "One of \"asc\" or \"desc\". Defaults to \"asc\" for alphabetical and position sort, \"desc\" for all others"
},
{
"key": "category_id",
"value": "<string>",
"description": "Filter triggers by category ID"
}
]
},
"description": "Lists all triggers for the current account.\n\n#### Pagination\n\n- Cursor pagination (recommended)\n- Offset pagination\n\nSee [Pagination](/api-reference/introduction/pagination/).\n\nReturns a maximum of 100 records per page.\n\n#### Allowed For\n\n* Agents\n\n#### Sideloads\n\nThe following sideloads are supported. The usage sideloads are only supported on the Support Professional or Suite Growth plan or above.\n\n| Name | Will sideload\n| ---------------- | -------------\n| app_installation | The app installation that requires each trigger, if present\n| permissions | The permissions for each trigger\n| usage_1h | The number of times each trigger has been used in the past hour\n| usage_24h | The number of times each trigger has been used in the past day\n| usage_7d | The number of times each trigger has been used in the past week\n| usage_30d | The number of times each trigger has been used in the past thirty days\n"
},
"response": [
{
"name": "Success response",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/triggers?active=<boolean>&sort_by=<string>&sort_order=<string>&category_id=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"triggers"
],
"query": [
{
"key": "active",
"value": "<boolean>",
"description": "Filter by active triggers if true or inactive triggers if false"
},
{
"key": "sort_by",
"value": "<string>",
"description": "Possible values are \"alphabetical\", \"created_at\", \"updated_at\", \"usage_1h\", \"usage_24h\", or \"usage_7d\". Defaults to \"position\""
},
{
"key": "sort_order",
"value": "<string>",
"description": "One of \"asc\" or \"desc\". Defaults to \"asc\" for alphabetical and position sort, \"desc\" for all others"
},
{
"key": "category_id",
"value": "<string>",
"description": "Filter triggers by category ID"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"count\": \"<integer>\",\n \"next_page\": \"<string>\",\n \"previous_page\": \"<string>\",\n \"triggers\": [\n {\n \"conditions\": {\n \"all\": [\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"any\": [\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n },\n \"actions\": [\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"title\": \"<string>\",\n \"active\": \"<boolean>\",\n \"category_id\": \"<string>\",\n \"created_at\": \"<string>\",\n \"default\": \"<boolean>\",\n \"description\": \"<string>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"raw_title\": \"<string>\",\n \"updated_at\": \"<string>\",\n \"url\": \"<string>\"\n },\n {\n \"conditions\": {\n \"all\": [\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"any\": [\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n },\n \"actions\": [\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"title\": \"<string>\",\n \"active\": \"<boolean>\",\n \"category_id\": \"<string>\",\n \"created_at\": \"<string>\",\n \"default\": \"<boolean>\",\n \"description\": \"<string>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"raw_title\": \"<string>\",\n \"updated_at\": \"<string>\",\n \"url\": \"<string>\"\n }\n ]\n}"
}
]
}