Chilkat Online Tools

Xojo / Support API / List Trigger Action and Condition Definitions

Back to Collection Items

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

Dim http As New Chilkat.Http
Dim success As Boolean

http.BasicAuth = True
http.Login = "login"
http.Password = "password"

http.SetRequestHeader "Accept","application/json"

Dim sbResponseBody As New Chilkat.StringBuilder
success = http.QuickGetSb("https://example.zendesk.com/api/v2/triggers/definitions",sbResponseBody)
If (success = False) Then
    System.DebugLog(http.LastErrorText)
    Return
End If

Dim jResp As New Chilkat.JsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

System.DebugLog("Response Body:")
System.DebugLog(jResp.Emit())

Dim respStatusCode As Int32
respStatusCode = http.LastStatus
System.DebugLog("Response Status Code = " + Str(respStatusCode))
If (respStatusCode >= 400) Then
    System.DebugLog("Response Header:")
    System.DebugLog(http.LastHeader)
    System.DebugLog("Failed.")
    Return
End If

// 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

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

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}"
    }
  ]
}