Objective-C / Support API / List Active Triggers
Back to Collection Items
#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.h>
#import <CkoStringBuilder.h>
#import <NSString.h>
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;
http.BasicAuth = YES;
http.Login = @"login";
http.Password = @"password";
CkoJsonObject *queryParams = [[CkoJsonObject alloc] init];
[queryParams UpdateString: @"sort_by" value: @"<string>"];
[queryParams UpdateString: @"sort_order" value: @"<string>"];
[queryParams UpdateString: @"category_id" value: @"<string>"];
[http SetRequestHeader: @"Accept" value: @"application/json"];
CkoHttpResponse *resp = [http QuickRequestParams: @"GET" url: @"https://example.zendesk.com/api/v2/triggers/active" json: queryParams];
if (http.LastMethodSuccess == NO) {
NSLog(@"%@",http.LastErrorText);
return;
}
CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
[resp GetBodySb: sbResponseBody];
CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;
NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);
int respStatusCode = [resp.StatusCode intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
NSLog(@"%@",@"Response Header:");
NSLog(@"%@",resp.Header);
NSLog(@"%@",@"Failed.");
return;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "count": "<integer>",
// "next_page": "<string>",
// "previous_page": "<string>",
// "triggers": [
// {
// "conditions": {
// "all": [
// {
// "field": "<string>",
// "operator": "<string>",
// "value": "<string>"
// },
// {
// "field": "<string>",
// "operator": "<string>",
// "value": "<string>"
// }
// ],
// "any": [
// {
// "field": "<string>",
// "operator": "<string>",
// "value": "<string>"
// },
// {
// "field": "<string>",
// "operator": "<string>",
// "value": "<string>"
// }
// ]
// },
// "actions": [
// {
// "field": "<string>",
// "value": "<string>"
// },
// {
// "field": "<string>",
// "value": "<string>"
// }
// ],
// "title": "<string>",
// "active": "<boolean>",
// "category_id": "<string>",
// "created_at": "<string>",
// "default": "<boolean>",
// "description": "<string>",
// "id": "<integer>",
// "position": "<integer>",
// "raw_title": "<string>",
// "updated_at": "<string>",
// "url": "<string>"
// },
// {
// "conditions": {
// "all": [
// {
// "field": "<string>",
// "operator": "<string>",
// "value": "<string>"
// },
// {
// "field": "<string>",
// "operator": "<string>",
// "value": "<string>"
// }
// ],
// "any": [
// {
// "field": "<string>",
// "operator": "<string>",
// "value": "<string>"
// },
// {
// "field": "<string>",
// "operator": "<string>",
// "value": "<string>"
// }
// ]
// },
// "actions": [
// {
// "field": "<string>",
// "value": "<string>"
// },
// {
// "field": "<string>",
// "value": "<string>"
// }
// ],
// "title": "<string>",
// "active": "<boolean>",
// "category_id": "<string>",
// "created_at": "<string>",
// "default": "<boolean>",
// "description": "<string>",
// "id": "<integer>",
// "position": "<integer>",
// "raw_title": "<string>",
// "updated_at": "<string>",
// "url": "<string>"
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
NSString *title = 0;
NSString *active = 0;
NSString *category_id = 0;
NSString *created_at = 0;
NSString *default = 0;
NSString *description = 0;
NSString *id = 0;
NSString *position = 0;
NSString *raw_title = 0;
NSString *updated_at = 0;
NSString *url = 0;
int j;
int count_j;
NSString *field = 0;
NSString *operator = 0;
NSString *value = 0;
NSString *count = [jResp StringOf: @"count"];
NSString *next_page = [jResp StringOf: @"next_page"];
NSString *previous_page = [jResp StringOf: @"previous_page"];
int i = 0;
int count_i = [[jResp SizeOfArray: @"triggers"] intValue];
while (i < count_i) {
jResp.I = [NSNumber numberWithInt: i];
title = [jResp StringOf: @"triggers[i].title"];
active = [jResp StringOf: @"triggers[i].active"];
category_id = [jResp StringOf: @"triggers[i].category_id"];
created_at = [jResp StringOf: @"triggers[i].created_at"];
default = [jResp StringOf: @"triggers[i].default"];
description = [jResp StringOf: @"triggers[i].description"];
id = [jResp StringOf: @"triggers[i].id"];
position = [jResp StringOf: @"triggers[i].position"];
raw_title = [jResp StringOf: @"triggers[i].raw_title"];
updated_at = [jResp StringOf: @"triggers[i].updated_at"];
url = [jResp StringOf: @"triggers[i].url"];
j = 0;
count_j = [[jResp SizeOfArray: @"triggers[i].conditions.all"] intValue];
while (j < count_j) {
jResp.J = [NSNumber numberWithInt: j];
field = [jResp StringOf: @"triggers[i].conditions.all[j].field"];
operator = [jResp StringOf: @"triggers[i].conditions.all[j].operator"];
value = [jResp StringOf: @"triggers[i].conditions.all[j].value"];
j = j + 1;
}
j = 0;
count_j = [[jResp SizeOfArray: @"triggers[i].conditions.any"] intValue];
while (j < count_j) {
jResp.J = [NSNumber numberWithInt: j];
field = [jResp StringOf: @"triggers[i].conditions.any[j].field"];
operator = [jResp StringOf: @"triggers[i].conditions.any[j].operator"];
value = [jResp StringOf: @"triggers[i].conditions.any[j].value"];
j = j + 1;
}
j = 0;
count_j = [[jResp SizeOfArray: @"triggers[i].actions"] intValue];
while (j < count_j) {
jResp.J = [NSNumber numberWithInt: j];
field = [jResp StringOf: @"triggers[i].actions[j].field"];
value = [jResp StringOf: @"triggers[i].actions[j].value"];
j = j + 1;
}
i = i + 1;
}
Curl Command
curl -u login:password -G -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/active
Postman Collection Item JSON
{
"name": "List Active Triggers",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/triggers/active?sort_by=<string>&sort_order=<string>&category_id=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"triggers",
"active"
],
"query": [
{
"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 active triggers.\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#### Allowed For\n\n* Agents\n\n#### Sideloads\n\nThe following sideloads are supported:\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?sort_by=<string>&sort_order=<string>&category_id=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"triggers",
"active"
],
"query": [
{
"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}"
}
]
}
