Chilkat Online Tools

VBScript / Support API / Create Automation

Back to Collection Items

Dim fso, outFile
Set fso = CreateObject("Scripting.FileSystemObject")
'Create a Unicode (utf-16) output text file.
Set outFile = fso.CreateTextFile("output.txt", True, True)

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

' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.Http")
set http = CreateObject("Chilkat.Http")

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

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

' resp is a Chilkat.HttpResponse
Set resp = http.QuickRequest("POST","https://example.zendesk.com/api/v2/automations")
If (http.LastMethodSuccess = 0) Then
    outFile.WriteLine(http.LastErrorText)
    WScript.Quit
End If

' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.StringBuilder")
set sbResponseBody = CreateObject("Chilkat.StringBuilder")
success = resp.GetBodySb(sbResponseBody)

' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.JsonObject")
set jResp = CreateObject("Chilkat.JsonObject")
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0

outFile.WriteLine("Response Body:")
outFile.WriteLine(jResp.Emit())

respStatusCode = resp.StatusCode
outFile.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
    outFile.WriteLine("Response Header:")
    outFile.WriteLine(resp.Header)
    outFile.WriteLine("Failed.")

    WScript.Quit
End If

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

' {
'   "automation": {
'     "actions": [
'       {
'         "field": "<string>",
'         "value": "<string>"
'       },
'       {
'         "field": "<string>",
'         "value": "<string>"
'       }
'     ],
'     "active": "<boolean>",
'     "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>"
'         }
'       ]
'     },
'     "created_at": "<dateTime>",
'     "default": "<boolean>",
'     "id": "<integer>",
'     "position": "<integer>",
'     "raw_title": "<string>",
'     "title": "<string>",
'     "updated_at": "<dateTime>"
'   }
' }

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

Active = jResp.StringOf("automation.active")
Created_at = jResp.StringOf("automation.created_at")
Default = jResp.StringOf("automation.default")
Id = jResp.StringOf("automation.id")
Position = jResp.StringOf("automation.position")
Raw_title = jResp.StringOf("automation.raw_title")
Title = jResp.StringOf("automation.title")
Updated_at = jResp.StringOf("automation.updated_at")
i = 0
count_i = jResp.SizeOfArray("automation.actions")
Do While i < count_i
    jResp.I = i
    field = jResp.StringOf("automation.actions[i].field")
    value = jResp.StringOf("automation.actions[i].value")
    i = i + 1
Loop
i = 0
count_i = jResp.SizeOfArray("automation.conditions.all")
Do While i < count_i
    jResp.I = i
    field = jResp.StringOf("automation.conditions.all[i].field")
    operator = jResp.StringOf("automation.conditions.all[i].operator")
    value = jResp.StringOf("automation.conditions.all[i].value")
    i = i + 1
Loop
i = 0
count_i = jResp.SizeOfArray("automation.conditions.any")
Do While i < count_i
    jResp.I = i
    field = jResp.StringOf("automation.conditions.any[i].field")
    operator = jResp.StringOf("automation.conditions.any[i].operator")
    value = jResp.StringOf("automation.conditions.any[i].value")
    i = i + 1
Loop

outFile.Close

Curl Command

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

Postman Collection Item JSON

{
  "name": "Create Automation",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/automations",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "automations"
      ]
    },
    "description": "Creates an automation.\n\nNew automations must be unique and have at least one condition that is true only once or an action that nullifies at least one of the conditions. Active automations can have overlapping conditions but can't be identical.\n\nThe request must include the following conditions in the `all` array:\n\n- At least one time-based condition\n- At least one condition that checks one of the following fields: `status`, `type`, `group_id`, `assignee_id`, or `requester_id`.\n\n#### Allowed For\n\n* Agents\n"
  },
  "response": [
    {
      "name": "Created response",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/automations",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "automations"
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"automation\": {\n    \"actions\": [\n      {\n        \"field\": \"<string>\",\n        \"value\": \"<string>\"\n      },\n      {\n        \"field\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ],\n    \"active\": \"<boolean>\",\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    \"created_at\": \"<dateTime>\",\n    \"default\": \"<boolean>\",\n    \"id\": \"<integer>\",\n    \"position\": \"<integer>\",\n    \"raw_title\": \"<string>\",\n    \"title\": \"<string>\",\n    \"updated_at\": \"<dateTime>\"\n  }\n}"
    }
  ]
}