Chilkat Online Tools

Perl / Support API / List Active Triggers

Back to Collection Items

use chilkat();

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

$http = chilkat::CkHttp->new();

$http->put_BasicAuth(1);
$http->put_Login("login");
$http->put_Password("password");

$queryParams = chilkat::CkJsonObject->new();
$queryParams->UpdateString("sort_by","<string>");
$queryParams->UpdateString("sort_order","<string>");
$queryParams->UpdateString("category_id","<string>");

$http->SetRequestHeader("Accept","application/json");

# resp is a HttpResponse
$resp = $http->QuickRequestParams("GET","https://example.zendesk.com/api/v2/triggers/active",$queryParams);
if ($http->get_LastMethodSuccess() == 0) {
    print $http->lastErrorText() . "\r\n";
    exit;
}

$sbResponseBody = chilkat::CkStringBuilder->new();
$resp->GetBodySb($sbResponseBody);

$jResp = chilkat::CkJsonObject->new();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(0);

print "Response Body:" . "\r\n";
print $jResp->emit() . "\r\n";

$respStatusCode = $resp->get_StatusCode();
print "Response Status Code = " . $respStatusCode . "\r\n";
if ($respStatusCode >= 400) {
    print "Response Header:" . "\r\n";
    print $resp->header() . "\r\n";
    print "Failed." . "\r\n";

    exit;
}

# 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

$count = $jResp->stringOf("count");
$next_page = $jResp->stringOf("next_page");
$previous_page = $jResp->stringOf("previous_page");
$i = 0;
$count_i = $jResp->SizeOfArray("triggers");
while ($i < $count_i) {
    $jResp->put_I($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");
    while ($j < $count_j) {
        $jResp->put_J($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");
    while ($j < $count_j) {
        $jResp->put_J($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");
    while ($j < $count_j) {
        $jResp->put_J($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}"
    }
  ]
}