Chilkat Online Tools

Node.js / Support API / List Trigger Action and Condition Definitions

Back to Collection Items

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}


function chilkatExample() {

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

    var http = new chilkat.Http();
    var success;

    http.BasicAuth = true;
    http.Login = "login";
    http.Password = "password";

    http.SetRequestHeader("Accept","application/json");

    var sbResponseBody = new chilkat.StringBuilder();
    success = http.QuickGetSb("https://example.zendesk.com/api/v2/triggers/definitions",sbResponseBody);
    if (success == false) {
        console.log(http.LastErrorText);
        return;
    }

    var jResp = new chilkat.JsonObject();
    jResp.LoadSb(sbResponseBody);
    jResp.EmitCompact = false;

    console.log("Response Body:");
    console.log(jResp.Emit());

    var respStatusCode = http.LastStatus;
    console.log("Response Status Code = " + respStatusCode);
    if (respStatusCode >= 400) {
        console.log("Response Header:");
        console.log(http.LastHeader);
        console.log("Failed.");
        return;
    }

    // Sample JSON response:
    // (Sample code for parsing the JSON response is shown below)

    // {
    //   "definitions": {
    //     "type": "object",
    //     "properties": {
    //       "actions": {
    //         "type": "array",
    //         "items": {
    //           "type": "object",
    //           "properties": {
    //             "group": {
    //               "type": "string",
    //               "default": "<string>"
    //             },
    //             "nullable": {
    //               "type": "boolean",
    //               "default": "<boolean>"
    //             },
    //             "repeatable": {
    //               "type": "boolean",
    //               "default": "<boolean>"
    //             },
    //             "subject": {
    //               "type": "string",
    //               "default": "<string>"
    //             },
    //             "title": {
    //               "type": "string",
    //               "default": "<string>"
    //             },
    //             "type": {
    //               "type": "string",
    //               "default": "<string>"
    //             },
    //             "values": {
    //               "type": "array",
    //               "items": {
    //                 "type": "object",
    //                 "properties": {
    //                   "enabled": {
    //                     "type": "boolean",
    //                     "default": "<boolean>"
    //                   },
    //                   "title": {
    //                     "type": "string",
    //                     "default": "<string>"
    //                   },
    //                   "value": {
    //                     "type": "string",
    //                     "default": "<string>"
    //                   }
    //                 }
    //               },
    //               "maxItems": 2
    //             }
    //           }
    //         },
    //         "maxItems": 2
    //       },
    //       "conditions_all": {
    //         "type": "array",
    //         "items": {
    //           "type": "object",
    //           "properties": {
    //             "group": {
    //               "type": "string",
    //               "default": "<string>"
    //             },
    //             "nullable": {
    //               "type": "boolean",
    //               "default": "<boolean>"
    //             },
    //             "operators": {
    //               "type": "array",
    //               "items": {
    //                 "type": "object",
    //                 "properties": {
    //                   "terminal": {
    //                     "type": "boolean",
    //                     "default": "<boolean>"
    //                   },
    //                   "title": {
    //                     "type": "string",
    //                     "default": "<string>"
    //                   },
    //                   "value": {
    //                     "type": "string",
    //                     "default": "<string>"
    //                   }
    //                 }
    //               },
    //               "maxItems": 2
    //             },
    //             "repeatable": {
    //               "type": "boolean",
    //               "default": "<boolean>"
    //             },
    //             "subject": {
    //               "type": "string",
    //               "default": "<string>"
    //             },
    //             "title": {
    //               "type": "string",
    //               "default": "<string>"
    //             },
    //             "type": {
    //               "type": "string",
    //               "default": "<string>"
    //             },
    //             "values": {
    //               "type": "array",
    //               "items": {
    //                 "type": "object",
    //                 "properties": {
    //                   "enabled": {
    //                     "type": "boolean",
    //                     "default": "<boolean>"
    //                   },
    //                   "title": {
    //                     "type": "string",
    //                     "default": "<string>"
    //                   },
    //                   "value": {
    //                     "type": "string",
    //                     "default": "<string>"
    //                   }
    //                 }
    //               },
    //               "maxItems": 2
    //             }
    //           }
    //         },
    //         "maxItems": 2
    //       },
    //       "conditions_any": {
    //         "type": "array",
    //         "items": {
    //           "type": "object",
    //           "properties": {
    //             "group": {
    //               "type": "string",
    //               "default": "<string>"
    //             },
    //             "nullable": {
    //               "type": "boolean",
    //               "default": "<boolean>"
    //             },
    //             "operators": {
    //               "type": "array",
    //               "items": {
    //                 "type": "object",
    //                 "properties": {
    //                   "terminal": {
    //                     "type": "boolean",
    //                     "default": "<boolean>"
    //                   },
    //                   "title": {
    //                     "type": "string",
    //                     "default": "<string>"
    //                   },
    //                   "value": {
    //                     "type": "string",
    //                     "default": "<string>"
    //                   }
    //                 }
    //               },
    //               "maxItems": 2
    //             },
    //             "repeatable": {
    //               "type": "boolean",
    //               "default": "<boolean>"
    //             },
    //             "subject": {
    //               "type": "string",
    //               "default": "<string>"
    //             },
    //             "title": {
    //               "type": "string",
    //               "default": "<string>"
    //             },
    //             "type": {
    //               "type": "string",
    //               "default": "<string>"
    //             }
    //           }
    //         },
    //         "maxItems": 2
    //       }
    //     }
    //   }
    // }

    // Sample code for parsing the JSON response...
    // Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

    var v_Type = jResp.StringOf("definitions.type");
    var ActionsType = jResp.StringOf("definitions.properties.actions.type");
    var ItemsType = jResp.StringOf("definitions.properties.actions.items.type");
    var GroupType = jResp.StringOf("definitions.properties.actions.items.properties.group.type");
    var Default = jResp.StringOf("definitions.properties.actions.items.properties.group.default");
    var NullableType = jResp.StringOf("definitions.properties.actions.items.properties.nullable.type");
    var NullableDefault = jResp.StringOf("definitions.properties.actions.items.properties.nullable.default");
    var RepeatableType = jResp.StringOf("definitions.properties.actions.items.properties.repeatable.type");
    var RepeatableDefault = jResp.StringOf("definitions.properties.actions.items.properties.repeatable.default");
    var SubjectType = jResp.StringOf("definitions.properties.actions.items.properties.subject.type");
    var SubjectDefault = jResp.StringOf("definitions.properties.actions.items.properties.subject.default");
    var TitleType = jResp.StringOf("definitions.properties.actions.items.properties.title.type");
    var TitleDefault = jResp.StringOf("definitions.properties.actions.items.properties.title.default");
    var TypeType = jResp.StringOf("definitions.properties.actions.items.properties.type.type");
    var TypeDefault = jResp.StringOf("definitions.properties.actions.items.properties.type.default");
    var ValuesType = jResp.StringOf("definitions.properties.actions.items.properties.values.type");
    ItemsType = jResp.StringOf("definitions.properties.actions.items.properties.values.items.type");
    var EnabledType = jResp.StringOf("definitions.properties.actions.items.properties.values.items.properties.enabled.type");
    var EnabledDefault = jResp.StringOf("definitions.properties.actions.items.properties.values.items.properties.enabled.default");
    TitleType = jResp.StringOf("definitions.properties.actions.items.properties.values.items.properties.title.type");
    TitleDefault = jResp.StringOf("definitions.properties.actions.items.properties.values.items.properties.title.default");
    var ValueType = jResp.StringOf("definitions.properties.actions.items.properties.values.items.properties.value.type");
    var ValueDefault = jResp.StringOf("definitions.properties.actions.items.properties.values.items.properties.value.default");
    var MaxItems = jResp.IntOf("definitions.properties.actions.items.properties.values.maxItems");
    var ActionsMaxItems = jResp.IntOf("definitions.properties.actions.maxItems");
    var Conditions_allType = jResp.StringOf("definitions.properties.conditions_all.type");
    ItemsType = jResp.StringOf("definitions.properties.conditions_all.items.type");
    GroupType = jResp.StringOf("definitions.properties.conditions_all.items.properties.group.type");
    var GroupDefault = jResp.StringOf("definitions.properties.conditions_all.items.properties.group.default");
    NullableType = jResp.StringOf("definitions.properties.conditions_all.items.properties.nullable.type");
    NullableDefault = jResp.StringOf("definitions.properties.conditions_all.items.properties.nullable.default");
    var OperatorsType = jResp.StringOf("definitions.properties.conditions_all.items.properties.operators.type");
    ItemsType = jResp.StringOf("definitions.properties.conditions_all.items.properties.operators.items.type");
    var TerminalType = jResp.StringOf("definitions.properties.conditions_all.items.properties.operators.items.properties.terminal.type");
    var TerminalDefault = jResp.StringOf("definitions.properties.conditions_all.items.properties.operators.items.properties.terminal.default");
    TitleType = jResp.StringOf("definitions.properties.conditions_all.items.properties.operators.items.properties.title.type");
    TitleDefault = jResp.StringOf("definitions.properties.conditions_all.items.properties.operators.items.properties.title.default");
    ValueType = jResp.StringOf("definitions.properties.conditions_all.items.properties.operators.items.properties.value.type");
    ValueDefault = jResp.StringOf("definitions.properties.conditions_all.items.properties.operators.items.properties.value.default");
    var OperatorsMaxItems = jResp.IntOf("definitions.properties.conditions_all.items.properties.operators.maxItems");
    RepeatableType = jResp.StringOf("definitions.properties.conditions_all.items.properties.repeatable.type");
    RepeatableDefault = jResp.StringOf("definitions.properties.conditions_all.items.properties.repeatable.default");
    SubjectType = jResp.StringOf("definitions.properties.conditions_all.items.properties.subject.type");
    SubjectDefault = jResp.StringOf("definitions.properties.conditions_all.items.properties.subject.default");
    TitleType = jResp.StringOf("definitions.properties.conditions_all.items.properties.title.type");
    TitleDefault = jResp.StringOf("definitions.properties.conditions_all.items.properties.title.default");
    TypeType = jResp.StringOf("definitions.properties.conditions_all.items.properties.type.type");
    TypeDefault = jResp.StringOf("definitions.properties.conditions_all.items.properties.type.default");
    ValuesType = jResp.StringOf("definitions.properties.conditions_all.items.properties.values.type");
    ItemsType = jResp.StringOf("definitions.properties.conditions_all.items.properties.values.items.type");
    EnabledType = jResp.StringOf("definitions.properties.conditions_all.items.properties.values.items.properties.enabled.type");
    EnabledDefault = jResp.StringOf("definitions.properties.conditions_all.items.properties.values.items.properties.enabled.default");
    TitleType = jResp.StringOf("definitions.properties.conditions_all.items.properties.values.items.properties.title.type");
    TitleDefault = jResp.StringOf("definitions.properties.conditions_all.items.properties.values.items.properties.title.default");
    ValueType = jResp.StringOf("definitions.properties.conditions_all.items.properties.values.items.properties.value.type");
    ValueDefault = jResp.StringOf("definitions.properties.conditions_all.items.properties.values.items.properties.value.default");
    var ValuesMaxItems = jResp.IntOf("definitions.properties.conditions_all.items.properties.values.maxItems");
    var Conditions_allMaxItems = jResp.IntOf("definitions.properties.conditions_all.maxItems");
    var Conditions_anyType = jResp.StringOf("definitions.properties.conditions_any.type");
    ItemsType = jResp.StringOf("definitions.properties.conditions_any.items.type");
    GroupType = jResp.StringOf("definitions.properties.conditions_any.items.properties.group.type");
    GroupDefault = jResp.StringOf("definitions.properties.conditions_any.items.properties.group.default");
    NullableType = jResp.StringOf("definitions.properties.conditions_any.items.properties.nullable.type");
    NullableDefault = jResp.StringOf("definitions.properties.conditions_any.items.properties.nullable.default");
    OperatorsType = jResp.StringOf("definitions.properties.conditions_any.items.properties.operators.type");
    ItemsType = jResp.StringOf("definitions.properties.conditions_any.items.properties.operators.items.type");
    TerminalType = jResp.StringOf("definitions.properties.conditions_any.items.properties.operators.items.properties.terminal.type");
    TerminalDefault = jResp.StringOf("definitions.properties.conditions_any.items.properties.operators.items.properties.terminal.default");
    TitleType = jResp.StringOf("definitions.properties.conditions_any.items.properties.operators.items.properties.title.type");
    TitleDefault = jResp.StringOf("definitions.properties.conditions_any.items.properties.operators.items.properties.title.default");
    ValueType = jResp.StringOf("definitions.properties.conditions_any.items.properties.operators.items.properties.value.type");
    ValueDefault = jResp.StringOf("definitions.properties.conditions_any.items.properties.operators.items.properties.value.default");
    OperatorsMaxItems = jResp.IntOf("definitions.properties.conditions_any.items.properties.operators.maxItems");
    RepeatableType = jResp.StringOf("definitions.properties.conditions_any.items.properties.repeatable.type");
    RepeatableDefault = jResp.StringOf("definitions.properties.conditions_any.items.properties.repeatable.default");
    SubjectType = jResp.StringOf("definitions.properties.conditions_any.items.properties.subject.type");
    SubjectDefault = jResp.StringOf("definitions.properties.conditions_any.items.properties.subject.default");
    TitleType = jResp.StringOf("definitions.properties.conditions_any.items.properties.title.type");
    TitleDefault = jResp.StringOf("definitions.properties.conditions_any.items.properties.title.default");
    TypeType = jResp.StringOf("definitions.properties.conditions_any.items.properties.type.type");
    TypeDefault = jResp.StringOf("definitions.properties.conditions_any.items.properties.type.default");
    var Conditions_anyMaxItems = jResp.IntOf("definitions.properties.conditions_any.maxItems");

}

chilkatExample();

Curl Command

curl  -u login:password -X GET
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/triggers/definitions

Postman Collection Item JSON

{
  "name": "List Trigger Action and Condition Definitions",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/triggers/definitions",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "triggers",
        "definitions"
      ]
    },
    "description": "Returns the definitions of the actions a trigger can perform and the\ndefinitions of the conditions under which a trigger can execute. The\ndefinition of the action includes a title (\"Status\"), a type (\"list\"), and\npossible values. The definition of the condition includes the same fields\nas well as the possible operators.\n\nFor a list of supported actions, see the [Actions reference](/documentation/ticketing/reference-guides/actions-reference)\nFor a list of supported conditions, see the [Conditions reference](/documentation/ticketing/reference-guides/conditions-reference)\n\n#### Allowed For\n\n* Agents\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/definitions",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "triggers",
            "definitions"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"definitions\": {\n    \"type\": \"object\",\n    \"properties\": {\n      \"actions\": {\n        \"type\": \"array\",\n        \"items\": {\n          \"type\": \"object\",\n          \"properties\": {\n            \"group\": {\n              \"type\": \"string\",\n              \"default\": \"<string>\"\n            },\n            \"nullable\": {\n              \"type\": \"boolean\",\n              \"default\": \"<boolean>\"\n            },\n            \"repeatable\": {\n              \"type\": \"boolean\",\n              \"default\": \"<boolean>\"\n            },\n            \"subject\": {\n              \"type\": \"string\",\n              \"default\": \"<string>\"\n            },\n            \"title\": {\n              \"type\": \"string\",\n              \"default\": \"<string>\"\n            },\n            \"type\": {\n              \"type\": \"string\",\n              \"default\": \"<string>\"\n            },\n            \"values\": {\n              \"type\": \"array\",\n              \"items\": {\n                \"type\": \"object\",\n                \"properties\": {\n                  \"enabled\": {\n                    \"type\": \"boolean\",\n                    \"default\": \"<boolean>\"\n                  },\n                  \"title\": {\n                    \"type\": \"string\",\n                    \"default\": \"<string>\"\n                  },\n                  \"value\": {\n                    \"type\": \"string\",\n                    \"default\": \"<string>\"\n                  }\n                }\n              },\n              \"maxItems\": 2\n            }\n          }\n        },\n        \"maxItems\": 2\n      },\n      \"conditions_all\": {\n        \"type\": \"array\",\n        \"items\": {\n          \"type\": \"object\",\n          \"properties\": {\n            \"group\": {\n              \"type\": \"string\",\n              \"default\": \"<string>\"\n            },\n            \"nullable\": {\n              \"type\": \"boolean\",\n              \"default\": \"<boolean>\"\n            },\n            \"operators\": {\n              \"type\": \"array\",\n              \"items\": {\n                \"type\": \"object\",\n                \"properties\": {\n                  \"terminal\": {\n                    \"type\": \"boolean\",\n                    \"default\": \"<boolean>\"\n                  },\n                  \"title\": {\n                    \"type\": \"string\",\n                    \"default\": \"<string>\"\n                  },\n                  \"value\": {\n                    \"type\": \"string\",\n                    \"default\": \"<string>\"\n                  }\n                }\n              },\n              \"maxItems\": 2\n            },\n            \"repeatable\": {\n              \"type\": \"boolean\",\n              \"default\": \"<boolean>\"\n            },\n            \"subject\": {\n              \"type\": \"string\",\n              \"default\": \"<string>\"\n            },\n            \"title\": {\n              \"type\": \"string\",\n              \"default\": \"<string>\"\n            },\n            \"type\": {\n              \"type\": \"string\",\n              \"default\": \"<string>\"\n            },\n            \"values\": {\n              \"type\": \"array\",\n              \"items\": {\n                \"type\": \"object\",\n                \"properties\": {\n                  \"enabled\": {\n                    \"type\": \"boolean\",\n                    \"default\": \"<boolean>\"\n                  },\n                  \"title\": {\n                    \"type\": \"string\",\n                    \"default\": \"<string>\"\n                  },\n                  \"value\": {\n                    \"type\": \"string\",\n                    \"default\": \"<string>\"\n                  }\n                }\n              },\n              \"maxItems\": 2\n            }\n          }\n        },\n        \"maxItems\": 2\n      },\n      \"conditions_any\": {\n        \"type\": \"array\",\n        \"items\": {\n          \"type\": \"object\",\n          \"properties\": {\n            \"group\": {\n              \"type\": \"string\",\n              \"default\": \"<string>\"\n            },\n            \"nullable\": {\n              \"type\": \"boolean\",\n              \"default\": \"<boolean>\"\n            },\n            \"operators\": {\n              \"type\": \"array\",\n              \"items\": {\n                \"type\": \"object\",\n                \"properties\": {\n                  \"terminal\": {\n                    \"type\": \"boolean\",\n                    \"default\": \"<boolean>\"\n                  },\n                  \"title\": {\n                    \"type\": \"string\",\n                    \"default\": \"<string>\"\n                  },\n                  \"value\": {\n                    \"type\": \"string\",\n                    \"default\": \"<string>\"\n                  }\n                }\n              },\n              \"maxItems\": 2\n            },\n            \"repeatable\": {\n              \"type\": \"boolean\",\n              \"default\": \"<boolean>\"\n            },\n            \"subject\": {\n              \"type\": \"string\",\n              \"default\": \"<string>\"\n            },\n            \"title\": {\n              \"type\": \"string\",\n              \"default\": \"<string>\"\n            },\n            \"type\": {\n              \"type\": \"string\",\n              \"default\": \"<string>\"\n            }\n          }\n        },\n        \"maxItems\": 2\n      }\n    }\n  }\n}"
    }
  ]
}