PHP (Extension) / Support API / List Trigger Action and Condition Definitions
Back to Collection Items
<?php
include("chilkat_9_5_0.php");
$http->put_BasicAuth(true);$http->put_Login('login');$http->put_Password('password');$success = $http->QuickGetSb('https://example.zendesk.com/api/v2/triggers/definitions',$sbResponseBody);$jResp->LoadSb($sbResponseBody);$jResp->put_EmitCompact(false);$ItemsType = $jResp->stringOf('definitions.properties.actions.items.properties.values.items.type');$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');$ItemsType = $jResp->stringOf('definitions.properties.conditions_all.items.type');$GroupType = $jResp->stringOf('definitions.properties.conditions_all.items.properties.group.type');$NullableType = $jResp->stringOf('definitions.properties.conditions_all.items.properties.nullable.type');$NullableDefault = $jResp->stringOf('definitions.properties.conditions_all.items.properties.nullable.default');$ItemsType = $jResp->stringOf('definitions.properties.conditions_all.items.properties.operators.items.type');$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');$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');$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');
?>
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}"
}
]
}