Ruby / Support API / Create Automation
Back to Collection Items
require '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(true)
http.put_Login("login")
http.put_Password("password")
http.SetRequestHeader("Accept","application/json")
# resp is a CkHttpResponse
resp = http.QuickRequest("POST","https://example.zendesk.com/api/v2/automations")
if (http.get_LastMethodSuccess() == false)
print http.lastErrorText() + "\n";
exit
end
sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)
jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)
print "Response Body:" + "\n";
print jResp.emit() + "\n";
respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
print "Response Header:" + "\n";
print resp.header() + "\n";
print "Failed." + "\n";
exit
end
# 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")
while i < count_i
jResp.put_I(i)
field = jResp.stringOf("automation.actions[i].field")
value = jResp.stringOf("automation.actions[i].value")
i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("automation.conditions.all")
while i < count_i
jResp.put_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
end
i = 0
count_i = jResp.SizeOfArray("automation.conditions.any")
while i < count_i
jResp.put_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
end
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}"
}
]
}
