Xojo / Support API / Reorder Triggers
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 resp As Chilkat.HttpResponse
resp = http.QuickRequest("PUT","https://example.zendesk.com/api/v2/triggers/reorder")
If (http.LastMethodSuccess = False) Then
System.DebugLog(http.LastErrorText)
Return
End If
Dim sbResponseBody As New Chilkat.StringBuilder
success = resp.GetBodySb(sbResponseBody)
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 = resp.StatusCode
System.DebugLog("Response Status Code = " + Str(respStatusCode))
If (respStatusCode >= 400) Then
System.DebugLog("Response Header:")
System.DebugLog(resp.Header)
System.DebugLog("Failed.")
Return
End If
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "trigger": {
// "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>"
// }
// ]
// },
// "actions": [
// {
// "field": "<string>",
// "value": "<string>"
// },
// {
// "field": "<string>",
// "value": "<string>"
// }
// ],
// "title": "<string>",
// "active": "<boolean>",
// "category_id": "<string>",
// "created_at": "<string>",
// "default": "<boolean>",
// "description": "<string>",
// "id": "<integer>",
// "position": "<integer>",
// "raw_title": "<string>",
// "updated_at": "<string>",
// "url": "<string>"
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Dim field As String
Dim operator As String
Dim value As String
Dim Title As String
Title = jResp.StringOf("trigger.title")
Dim Active As String
Active = jResp.StringOf("trigger.active")
Dim Category_id As String
Category_id = jResp.StringOf("trigger.category_id")
Dim Created_at As String
Created_at = jResp.StringOf("trigger.created_at")
Dim Default As String
Default = jResp.StringOf("trigger.default")
Dim Description As String
Description = jResp.StringOf("trigger.description")
Dim Id As String
Id = jResp.StringOf("trigger.id")
Dim Position As String
Position = jResp.StringOf("trigger.position")
Dim Raw_title As String
Raw_title = jResp.StringOf("trigger.raw_title")
Dim Updated_at As String
Updated_at = jResp.StringOf("trigger.updated_at")
Dim v_Url As String
v_Url = jResp.StringOf("trigger.url")
Dim i As Int32
i = 0
Dim count_i As Int32
count_i = jResp.SizeOfArray("trigger.conditions.all")
While i < count_i
jResp.I = i
field = jResp.StringOf("trigger.conditions.all[i].field")
operator = jResp.StringOf("trigger.conditions.all[i].operator")
value = jResp.StringOf("trigger.conditions.all[i].value")
i = i + 1
Wend
i = 0
count_i = jResp.SizeOfArray("trigger.conditions.any")
While i < count_i
jResp.I = i
field = jResp.StringOf("trigger.conditions.any[i].field")
operator = jResp.StringOf("trigger.conditions.any[i].operator")
value = jResp.StringOf("trigger.conditions.any[i].value")
i = i + 1
Wend
i = 0
count_i = jResp.SizeOfArray("trigger.actions")
While i < count_i
jResp.I = i
field = jResp.StringOf("trigger.actions[i].field")
value = jResp.StringOf("trigger.actions[i].value")
i = i + 1
Wend
Curl Command
curl -u login:password -X PUT
-H "Accept: application/json"
https://example.zendesk.com/api/v2/triggers/reorder
Postman Collection Item JSON
{
"name": "Reorder Triggers",
"request": {
"method": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/triggers/reorder",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"triggers",
"reorder"
]
},
"description": "Alters the firing order of triggers in the account. See\n[Reordering and sorting triggers](https://support.zendesk.com/hc/en-us/articles/115015696088)\nin the Zendesk Help Center. The firing order is set in a `trigger_ids` array in the request body.\n\nYou must include every trigger id in your account to reorder the triggers. If not, the endpoint will return 404 Forbidden.\n\nReordering triggers via the API is not permitted if you have more than one trigger category. If there is more than one\ntrigger category, the endpoint will return a `LimitOneCategory` error.\n\n#### Allowed For\n\n* Agents\n"
},
"response": [
{
"name": "Success response",
"originalRequest": {
"method": "PUT",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/triggers/reorder",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"triggers",
"reorder"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"trigger\": {\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 \"actions\": [\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"title\": \"<string>\",\n \"active\": \"<boolean>\",\n \"category_id\": \"<string>\",\n \"created_at\": \"<string>\",\n \"default\": \"<boolean>\",\n \"description\": \"<string>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"raw_title\": \"<string>\",\n \"updated_at\": \"<string>\",\n \"url\": \"<string>\"\n }\n}"
}
]
}
