Trigger Categories

This example provides an example query with pagination parameters with cURL.

              

               
curl-u{email}:{password}-X GET\--url https://{subdomain}.zendesk.com/api/v2/trigger_categories
              

              

               
import("fmt""io""net/http")funcmain(){url:="https://example.zendesk.com/api/v2/trigger_categories?include=&page=%7B%22after%22%3A%22eyJvIjoiLXNjb3JlLGlkIiwidiI6ImFRSUFBQUFBQUFBQWFRMHBJUUVBQUFBQSJ9%22%2C%22before%22%3A%22eyJvIjoiLXNjb3JlLGlkIiwidiI6ImFRSUFBQUFBQUFBQWFRMHBJUUVBQUFBQSJ9%22%2C%22size%22%3A50%7D&sort="method:="GET"req,err:=http.NewRequest(method,url,nil)iferr!=nil{fmt.Println(err)return}req.Header.Add("Content-Type","application/json")req.Header.Add("Authorization","Basic ")// Base64 encoded "username:password"client:=&http.Client{}res,err:=client.Do(req)iferr!=nil{fmt.Println(err)return}deferres.Body.Close()body,err:=io.ReadAll(res.Body)iferr!=nil{fmt.Println(err)return}fmt.Println(string(body))}
              

              

               
importcom.squareup.okhttp.*;OkHttpClientclient=newOkHttpClient();HttpUrl.BuilderurlBuilder=HttpUrl.parse("https://example.zendesk.com/api/v2/trigger_categories").newBuilder().addQueryParameter("include","").addQueryParameter("page","{"after":"eyJvIjoiLXNjb3JlLGlkIiwidiI6ImFRSUFBQUFBQUFBQWFRMHBJUUVBQUFBQSJ9","before":"eyJvIjoiLXNjb3JlLGlkIiwidiI6ImFRSUFBQUFBQUFBQWFRMHBJUUVBQUFBQSJ9","size":50}").addQueryParameter("sort","");Requestrequest=newRequest.Builder().url(urlBuilder.build()).method("GET",null).addHeader("Content-Type","application/json").addHeader("Authorization",Credentials.basic("your-email","your-password")).build();Responseresponse=client.newCall(request).execute();
              

This example provides an example query with pagination parameters in JavaScript.

              

               
fetch("https://{subdomain}.zendesk.com/api/v2/trigger_categories?include=rule_counts&page[size]=10&page[after]=eyJvIjoiLXNjb3JlLGlkIiwidiI6ImFRSUFBQUFBQUFBQWFRMHBJUUVBQUFBQSJ9",{"method":"GET","headers":{}}).then(response=>{// do stuff with successful response}).catch(err=>{// do stuff with failed response});
              

              

               
varaxios=require('axios');varconfig={method:'GET',url:“https://example.亚博zendesk.com/api/v2/trigger_categories',headers:{'Content-Type':'application/json','Authorization':'Basic ',// Base64 encoded "username:password"},params:{'include':'','page':“% 7 b % % 3 22% % 22 eyjvijoilxnjb3jllglkiiwidii6i后22mFRSUFBQUFBQUFBQWFRMHBJUUVBQUFBQSJ9%22%2C%22before%22%3A%22eyJvIjoiLXNjb3JlLGlkIiwidiI6ImFRSUFBQUFBQUFBQWFRMHBJUUVBQUFBQSJ9%22%2C%22size%22%3A50%7D','sort':'',},};axios(config).then(function(response){console.log(JSON.stringify(response.data));}).catch(function(error){console.log(error);});
              

              

               
importrequestsurl="https://example.zendesk.com/api/v2/trigger_categories?include=&page=%7B%22after%22%3A%22eyJvIjoiLXNjb3JlLGlkIiwidiI6ImFRSUFBQUFBQUFBQWFRMHBJUUVBQUFBQSJ9%22%2C%22before%22%3A%22eyJvIjoiLXNjb3JlLGlkIiwidiI6ImFRSUFBQUFBQUFBQWFRMHBJUUVBQUFBQSJ9%22%2C%22size%22%3A50%7D&sort="headers={"Content-Type":"application/json",}response=requests.request("GET",url,auth=('',''),headers=headers)print(response.text)
              

              

               
require"net/http"uri=URI("https://example.zendesk.com/api/v2/trigger_categories")uri.query=URI.encode_www_form("include":"","page":"{"after":"eyJvIjoiLXNjb3JlLGlkIiwidiI6ImFRSUFBQUFBQUFBQWFRMHBJUUVBQUFBQSJ9","before":"eyJvIjoiLXNjb3JlLGlkIiwidiI6ImFRSUFBQUFBQUFBQWFRMHBJUUVBQUFBQSJ9","size":50}","sort":"")request=Net::HTTP::Get.new(uri,"Content-Type":"application/json")request.basic_auth"username","password"response=Net::HTTP.start uri.hostname,uri.port,use_ssl:truedo|http|http.request(request)end
              

              

               
// Status 200 OK{"links":{"next":"https://{subdomain}.zendesk.com/api/v2/trigger_categories.json?include=rule_counts&page[after]=eyJvIjoiLXNjb3JlLGlkIiwidiI6ImFRSUFBQUFBQUFBQWFRMHBJUUVBQUFBQSJ9&page[size]=2&sort=position","prev":"https://{subdomain}.zendesk.com/api/v2/trigger_categories.json?include=rule_counts&page[before]=eyJvIjoiLXNjb3JlLGlkIiwidiI6ImFRSUFBQUFBQUFBQWFRMHBJUUVBQUFBQSJ9&page[size]=2&sort=position"},"meta":{"after_cursor":"eyJvIjoiLXNjb3JlLGlkIiwidiI6ImFRSUFBQUFBQUFBQWFRMHBJUUVBQUFBQSJ9","before_cursor":"eyJvIjoiLXNjb3JlLGlkIiwidiI6ImFRSUFBQUFBQUFBQWFRMHBJUUVBQUFBQSJ9","has_more":true},"trigger_categories":[{"created_at":"2020-07-17T01:30:07Z","id":"10001","name":"Email Triggers","position":0,"updated_at":"2020-07-17T01:30:07Z"},{"created_at":"2020-07-17T01:30:07Z","id":"10002","name":"SMS Triggers","position":1,"updated_at":"2020-07-17T01:30:07Z"}]}
              

              

               
// Status 400 Bad Request{"errors":[{"code":"InvalidPaginationParameter","title":"page[after] is not valid"}]}
              

              

               
// Status 403 Forbidden{"errors":[{"code":"TriggerCategoriesNotEnabled","title":"Trigger categories are not enabled for your account"}]}
              

This example provides an example trigger category POST request with cURL.

              

               
curl-u{email}:{password}-X POST\--url https://{subdomain}.zendesk.com/api/v2/trigger_categories\-H'content-type: application/json'\-d'{"trigger_category": {"name": "Example Category","position": 10}}'
              

              

               
import("fmt""io""net/http""strings")funcmain(){url:="https://example.zendesk.com/api/v2/trigger_categories"method:="POST"payload:=strings.NewReader(`{"trigger_category": {"name": "All Notification Triggers","position": 0}}`)req,err:=http.NewRequest(method,url,payload)iferr!=nil{fmt.Println(err)return}req.Header.Add("Content-Type","application/json")req.Header.Add("Authorization","Basic ")// Base64 encoded "username:password"client:=&http.Client{}res,err:=client.Do(req)iferr!=nil{fmt.Println(err)return}deferres.Body.Close()body,err:=io.ReadAll(res.Body)iferr!=nil{fmt.Println(err)return}fmt.Println(string(body))}
              

              

               
importcom.squareup.okhttp.*;OkHttpClientclient=newOkHttpClient();HttpUrl.BuilderurlBuilder=HttpUrl.parse("https://example.zendesk.com/api/v2/trigger_categories").newBuilder();RequestBodybody=RequestBody.create(MediaType.parse("application/json"),"""{\"trigger_category\":{\"name\":\"AllNotificationTriggers\",\"position\":0}}""");Requestrequest=newRequest.Builder().url(urlBuilder.build()).method("POST",body).addHeader("Content-Type","application/json").addHeader("Authorization",Credentials.basic("your-email","your-password")).build();Responseresponse=client.newCall(request).execute();
              

This example provides an example trigger category POST request in JavaScript.

              

               
fetch("https://{subdomain}.zendesk.com/api/v2/trigger_categories",{"method":"POST","headers":{"content-type":"application/json"},"body":{"trigger_category":{"name":"Example Category","position":10}}}).then(response=>{// do stuff with successful response}).catch(err=>{// do stuff with failed response});
              

              

               
varaxios=require('axios');vardata=JSON.stringify({"trigger_category":{"name":"All Notification Triggers","position":0}});varconfig={method:'POST',url:“https://example.亚博zendesk.com/api/v2/trigger_categories',headers:{'Content-Type':'application/json','Authorization':'Basic ',// Base64 encoded "username:password"},data:data,};axios(config).then(function(response){console.log(JSON.stringify(response.data));}).catch(function(error){console.log(error);});
              

              

               
importrequestsimportjsonurl="https://example.zendesk.com/api/v2/trigger_categories"payload=json.loads("""{"trigger_category": {"name": "All Notification Triggers","position": 0}}""")headers={"Content-Type":"application/json",}response=requests.request("POST",url,auth=('',''),headers=headers,json=payload)print(response.text)
              

              

               
require"net/http"uri=URI("https://example.zendesk.com/api/v2/trigger_categories")request=Net::HTTP::Post.new(uri,"Content-Type":"application/json")request.body=%q({"trigger_category":{"name":"All Notification Triggers","position":0}})request.basic_auth"username","password"response=Net::HTTP.start uri.hostname,uri.port,use_ssl:truedo|http|http.request(request)end
              

              

               
// Status 200 OK{"trigger_category":{"created_at":"2020-07-17T01:30:07Z","id":"10001","name":"All Notification Triggers","position":0,"updated_at":"2020-07-17T01:30:07Z"}}
              

              

               
// Status 400 Bad Request{"errors":[{"code":"InvalidTriggerCategory","title":"Name cannot be blank"}]}
              

              

               
// Status 403 Forbidden{"errors":[{"code":"TriggerCategoriesNotEnabled","title":"Trigger categories are not enabled for your account"},{"code":"ProductLimitExceeded","title":"Your account has reached the limit of 500 trigger categories."}]}
              

This example provides an example request for batch operating on existing trigger categories with cURL.

              

               
curl-u{email}:{password}-X POST\--url https://{subdomain}.zendesk.com/api/v2/trigger_categories/jobs\-H'content-type: application/json'\-d'{"job": {"action": "patch","items": {"trigger_categories": [{"id": "10001","position": 20},{"id": "10002","position": 21}],"triggers": [{"id": "10011","position": 10,"active": false,"category_id": "10001"},{"id": "10012","position": 1,"active": true,"category_id": "10002"}]}}}'
              

              

               
import("fmt""io""net/http""strings")funcmain(){url:="https://example.zendesk.com/api/v2/trigger_categories/jobs"method:="POST"payload:=strings.NewReader(`{"job": {"action": "patch","items": {"trigger_categories": [{"id": "10001","position": 0},{"id": "10002","position": 1}],"triggers": [{"active": false,"category_id": "10001","id": "10011","position": 10},{"active": true,"category_id": "10002","id": "10012","position": 1}]}}}`)req,err:=http.NewRequest(method,url,payload)iferr!=nil{fmt.Println(err)return}req.Header.Add("Content-Type","application/json")req.Header.Add("Authorization","Basic ")// Base64 encoded "username:password"client:=&http.Client{}res,err:=client.Do(req)iferr!=nil{fmt.Println(err)return}deferres.Body.Close()body,err:=io.ReadAll(res.Body)iferr!=nil{fmt.Println(err)return}fmt.Println(string(body))}
              

              

               
importcom.squareup.okhttp.*;OkHttpClientclient=newOkHttpClient();HttpUrl.BuilderurlBuilder=HttpUrl.parse("https://example.zendesk.com/api/v2/trigger_categories/jobs").newBuilder();RequestBodybody=RequestBody.create(MediaType.parse("application/json"),"""{\"job\":{\"action\":\"patch\",\"items\":{\"trigger_categories\":[{\"id\":\"10001\",\"position\":0},{\"id\":\"10002\",\"position\":1}],\"triggers\":[{\"active\":false,\"category_id\":\"10001\",\"id\":\"10011\",\"position\":10},{\"active\":true,\"category_id\":\"10002\",\"id\":\"10012\",\"position\":1}]}}}""");Requestrequest=newRequest.Builder().url(urlBuilder.build()).method("POST",body).addHeader("Content-Type","application/json").addHeader("Authorization",Credentials.basic("your-email","your-password")).build();Responseresponse=client.newCall(request).execute();
              

This example provides an example request for batch operating on existing trigger categories in JavaScript.

              

               
fetch("https://{subdomain}.zendesk.com/api/v2/trigger_categories/jobs",{"method":"POST","headers":{"content-type":"application/json"},"body":{"job":{"action":"patch","items":{"trigger_categories":[{"id":"10001","position":20},{"id":"10002","position":21}],"triggers":[{"id":“10011”,"position":10,"active":false,"category_id":"10001"},{"id":"10012","position":1,"active":true,"category_id":"10002"}]}}}}).then(response=>{// do stuff with successful response}).catch(err=>{// do stuff with failed response});
              

              

               
varaxios=require('axios');vardata=JSON.stringify({"job":{"action":"patch","items":{"trigger_categories":[{"id":"10001","position":0},{"id":"10002","position":1}],"triggers":[{"active":false,"category_id":"10001","id":“10011”,"position":10},{"active":true,"category_id":"10002","id":"10012","position":1}]}}});varconfig={method:'POST',url:“https://example.亚博zendesk.com/api/v2/trigger_categories/jobs',headers:{'Content-Type':'application/json','Authorization':'Basic ',// Base64 encoded "username:password"},data:data,};axios(config).then(function(response){console.log(JSON.stringify(response.data));}).catch(function(error){console.log(error);});
              

              

               
importrequestsimportjsonurl="https://example.zendesk.com/api/v2/trigger_categories/jobs"payload=json.loads("""{"job": {"action": "patch","items": {"trigger_categories": [{"id": "10001","position": 0},{"id": "10002","position": 1}],"triggers": [{"active": false,"category_id": "10001","id": "10011","position": 10},{"active": true,"category_id": "10002","id": "10012","position": 1}]}}}""")headers={"Content-Type":"application/json",}response=requests.request("POST",url,auth=('',''),headers=headers,json=payload)print(response.text)
              

              

               
require"net/http"uri=URI("https://example.zendesk.com/api/v2/trigger_categories/jobs")request=Net::HTTP::Post.new(uri,"Content-Type":"application/json")request.body=%q({"job":{"action":"patch","items":{"trigger_categories":[{"id":"10001","position":0},{"id":"10002","position":1}],"triggers":[{"active":false,"category_id":"10001","id":“10011”,"position":10},{"active":true,"category_id":"10002","id":"10012","position":1}]}}})request.basic_auth"username","password"response=Net::HTTP.start uri.hostname,uri.port,use_ssl:truedo|http|http.request(request)end
              

              

               
// Status 200 OK{"results":{"trigger_categories":[{"created_at":"2020-07-18T01:24:53Z","id":"10001","name":"Notifications","position":0,"updated_at":"2020-07-20T01:30:07Z"},{"created_at":"2020-07-17T06:31:12Z","id":"10002","name":"Apply Tags","position":1,"updated_at":"2020-07-20T01:30:07Z"}],"triggers":[{"actions":[{}],"active":true,"conditions":{},"created_at":"2012-09-25T22:50:26Z","description":"Notify external target","id":10012,"position":1,"raw_title":"Notify target","title":"Notify Target","updated_at":"2020-07-20T01:30:07Z","url":"http://{subdomain}.zendesk.com/api/v2/triggers/10012.json"},{"actions":[{}],"active":false,"conditions":{},"created_at":"2012-09-25T22:50:26Z","description":"Close and save a ticket","id":10011,"position":10,"raw_title":"Close and Save","title":"Close and Save","updated_at":"2020-07-20T01:30:07Z","url":"http://{subdomain}.zendesk.com/api/v2/triggers/10011.json"}]},"status":"complete"}
              

              

               
// Status 400 Bad Request{"errors":[{"code":"InvalidTrigger","title":"category_id is not valid","trigger_id":"10001"}],"status":“失败”}
              

This example provides an example request for an existing trigger category with cURL.

              

               
curl-u{email}:{password}-X GET\--url https://{subdomain}.zendesk.com/api/v2/trigger_categories/10001
              

              

               
import("fmt""io""net/http")funcmain(){url:="https://example.zendesk.com/api/v2/trigger_categories/10001"method:="GET"req,err:=http.NewRequest(method,url,nil)iferr!=nil{fmt.Println(err)return}req.Header.Add("Content-Type","application/json")req.Header.Add("Authorization","Basic ")// Base64 encoded "username:password"client:=&http.Client{}res,err:=client.Do(req)iferr!=nil{fmt.Println(err)return}deferres.Body.Close()body,err:=io.ReadAll(res.Body)iferr!=nil{fmt.Println(err)return}fmt.Println(string(body))}
              

              

               
importcom.squareup.okhttp.*;OkHttpClientclient=newOkHttpClient();HttpUrl.BuilderurlBuilder=HttpUrl.parse("https://example.zendesk.com/api/v2/trigger_categories/10001").newBuilder();Requestrequest=newRequest.Builder().url(urlBuilder.build()).method("GET",null).addHeader("Content-Type","application/json").addHeader("Authorization",Credentials.basic("your-email","your-password")).build();Responseresponse=client.newCall(request).execute();
              

This example provides an example request for an existing trigger category in JavaScript.

              

               
fetch("https://{subdomain}.zendesk.com/api/v2/trigger_categories/10001",{"method":"GET","headers":{}}).then(response=>{// do stuff with successful response}).catch(err=>{// do stuff with failed response});
              

              

               
varaxios=require('axios');varconfig={method:'GET',url:“https://example.亚博zendesk.com/api/v2/trigger_categories/10001',headers:{'Content-Type':'application/json','Authorization':'Basic ',// Base64 encoded "username:password"},};axios(config).then(function(response){console.log(JSON.stringify(response.data));}).catch(function(error){console.log(error);});
              

              

               
importrequestsurl="https://example.zendesk.com/api/v2/trigger_categories/10001"headers={"Content-Type":"application/json",}response=requests.request("GET",url,auth=('',''),headers=headers)print(response.text)
              

              

               
require"net/http"uri=URI("https://example.zendesk.com/api/v2/trigger_categories/10001")request=Net::HTTP::Get.new(uri,"Content-Type":"application/json")request.basic_auth"username","password"response=Net::HTTP.start uri.hostname,uri.port,use_ssl:truedo|http|http.request(request)end
              

              

               
// Status 200 OK{"trigger_category":{"created_at":"2020-07-17T01:30:07Z","id":"10001","name":"All Notification Triggers","position":0,"updated_at":"2020-07-17T01:30:07Z"}}
              

              

               
// Status 404 Not Found{"errors":[{"code":"TriggerCategoryNotFound","title":"Category can’t be found. Check the ID and try again."}]}
              

This example provides an example request for updating an existing trigger category with cURL.

              

               
curl-u{email}:{password}-X PATCH\--url https://{subdomain}.zendesk.com/api/v2/trigger_categories/10001\-H'content-type: application/json'\-d'{"trigger_category": {"name": "Example Category Updated"}}'
              

              

               
import("fmt""io""net/http""strings")funcmain(){url:="https://example.zendesk.com/api/v2/trigger_categories/10001"method:="PATCH"payload:=strings.NewReader(`{"trigger_category": {"name": "All Notification Triggers Updated","position": 10}}`)req,err:=http.NewRequest(method,url,payload)iferr!=nil{fmt.Println(err)return}req.Header.Add("Content-Type","application/json")req.Header.Add("Authorization","Basic ")// Base64 encoded "username:password"client:=&http.Client{}res,err:=client.Do(req)iferr!=nil{fmt.Println(err)return}deferres.Body.Close()body,err:=io.ReadAll(res.Body)iferr!=nil{fmt.Println(err)return}fmt.Println(string(body))}
              

              

               
importcom.squareup.okhttp.*;OkHttpClientclient=newOkHttpClient();HttpUrl.BuilderurlBuilder=HttpUrl.parse("https://example.zendesk.com/api/v2/trigger_categories/10001").newBuilder();RequestBodybody=RequestBody.create(MediaType.parse("application/json"),"""{\"trigger_category\":{\"name\":\"AllNotificationTriggersUpdated\",\"position\":10}}""");Requestrequest=newRequest.Builder().url(urlBuilder.build()).method("PATCH",body).addHeader("Content-Type","application/json").addHeader("Authorization",Credentials.basic("your-email","your-password")).build();Responseresponse=client.newCall(request).execute();
              

This example provides an example request for updating an existing trigger category in JavaScript.

              

               
fetch("https://{subdomain}.zendesk.com/api/v2/trigger_categories/10001",{"method":"PATCH","headers":{"content-type":"application/json"},"body":{"trigger_category":{"name":"Example Category Updated"}}}).then(response=>{// do stuff with successful response}).catch(err=>{// do stuff with failed response});
              

              

               
varaxios=require('axios');vardata=JSON.stringify({"trigger_category":{"name":"All Notification Triggers Updated","position":10}});varconfig={method:'PATCH',url:“https://example.亚博zendesk.com/api/v2/trigger_categories/10001',headers:{'Content-Type':'application/json','Authorization':'Basic ',// Base64 encoded "username:password"},data:data,};axios(config).then(function(response){console.log(JSON.stringify(response.data));}).catch(function(error){console.log(error);});
              

              

               
importrequestsimportjsonurl="https://example.zendesk.com/api/v2/trigger_categories/10001"payload=json.loads("""{"trigger_category": {"name": "All Notification Triggers Updated","position": 10}}""")headers={"Content-Type":"application/json",}response=requests.request("PATCH",url,auth=('',''),headers=headers,json=payload)print(response.text)
              

              

               
require"net/http"uri=URI("https://example.zendesk.com/api/v2/trigger_categories/10001")request=Net::HTTP::Patch.new(uri,"Content-Type":"application/json")request.body=%q({"trigger_category":{"name":"All Notification Triggers Updated","position":10}})request.basic_auth"username","password"response=Net::HTTP.start uri.hostname,uri.port,use_ssl:truedo|http|http.request(request)end
              

              

               
// Status 200 OK{"trigger_category":{"created_at":"2020-07-17T01:30:07Z","id":"10001","name":"All Notification Triggers Updated","position":10,"updated_at":"2020-07-18T05:23:32Z"}}
              

              

               
// Status 400 Bad Request{"errors":[{"code":"InvalidTriggerCategory","title":"Name cannot be blank"}]}
              

              

               
// Status 404 Not Found{"errors":[{"code":"TriggerCategoryNotFound","title":"Category can’t be found. Check the ID and try again."}]}
              

This example provides an example request for deleting an existing trigger category with cURL.

              

               
curl-u{email}:{password}-X DELETE\--url https://{subdomain}.zendesk.com/api/v2/trigger_categories/10001
              

              

               
import("fmt""io""net/http")funcmain(){url:="https://example.zendesk.com/api/v2/trigger_categories/10001"method:="DELETE"req,err:=http.NewRequest(method,url,nil)iferr!=nil{fmt.Println(err)return}req.Header.Add("Content-Type","application/json")req.Header.Add("Authorization","Basic ")// Base64 encoded "username:password"client:=&http.Client{}res,err:=client.Do(req)iferr!=nil{fmt.Println(err)return}deferres.Body.Close()body,err:=io.ReadAll(res.Body)iferr!=nil{fmt.Println(err)return}fmt.Println(string(body))}
              

              

               
importcom.squareup.okhttp.*;OkHttpClientclient=newOkHttpClient();HttpUrl.BuilderurlBuilder=HttpUrl.parse("https://example.zendesk.com/api/v2/trigger_categories/10001").newBuilder();Requestrequest=newRequest.Builder().url(urlBuilder.build()).method("DELETE",null).addHeader("Content-Type","application/json").addHeader("Authorization",Credentials.basic("your-email","your-password")).build();Responseresponse=client.newCall(request).execute();
              

This example provides an example request for deleting an existing trigger category in JavaScript.

              

               
fetch("https://{subdomain}.zendesk.com/api/v2/trigger_categories/10001",{"method":"DELETE","headers":{}}).then(response=>{// do stuff with successful response}).catch(err=>{// do stuff with failed response});
              

              

               
varaxios=require('axios');varconfig={method:'DELETE',url:“https://example.亚博zendesk.com/api/v2/trigger_categories/10001',headers:{'Content-Type':'application/json','Authorization':'Basic ',// Base64 encoded "username:password"},};axios(config).then(function(response){console.log(JSON.stringify(response.data));}).catch(function(error){console.log(error);});