Note: This section assumes existing knowledge of JSON. If you are new to JSON please visit
https://www.json.org/ before continuing.
Simple Escalation Chain Destination JSON Strings:
The JSON string for a non-timebased (simple) escalation chain requires the following values (Note: destination and ccdestination objects must be URL encoded in your request):
Parameter
|
Type
|
Description
|
type |
String |
The type of the escalation chain. For simple chains this value should be set to “simple”. |
stages |
JSON String |
A list of JSON string represented Stage objects. Each stage defined in the escalation chain must be a valid JSON string containing addr, method, comment, and type values. |
addr |
String |
The name of either a user or a recipient group |
method |
String |
If the addr references a user, this specifies the delivery method. Common values include “email” and “sms” |
comment |
String |
Long text description of the stage |
type |
String |
Either “admin” or “group” depending on the addr value. If the addr value is pointing to a user should be “admin”. If pointing to a recipient group use “group”. |
------------- Sample Destination (URL decoded for readability) -------------
destination=[{"type":"simple","stages":[[{"addr":"oncall0","method":"","comment":"","type":"group"}]]}]
----------------------------------------------------------------------------
Time-Based Escalation Chain Destination JSON Strings:
The JSON string for a time-based escalation chain requires the following values (Note: this object must be URL encoded in your request):
Parameter
|
Type
|
Description
|
type |
String |
The type of the escalation chain. For timebased chains this value should be set to “timebased”. |
period |
JSON String |
A JSON representation of the days of the week and times of day that this escalation chain. e.g. {“weekdays”:”1|2|3″,”start”:0,”end”:1440} for all day Sunday, Monday and Tuesday or {“weekdays”:”1|2|3|4|5|6|7″,”start”:360,”end”:1050} for every day from 6:00 am to 5:30 pm |
stages |
JSON String |
A list of JSON string represented Stage objects. Each stage defined in the escalation chain must be a valid JSON string containing addr, method, comment, and type values. |
addr |
String |
The name of either a user or a recipient group |
method |
String |
If the addr references a user, this specifies the delivery method. Common values include “email” and “sms” |
comment |
String |
Long text description of the stage |
type |
String |
Either “admin” or “group” depending on the addr value. If the addr value is pointing to a user should be “admin”. If pointing to a recipient group use “group”. |
------------Sample Destination (URL decoded for readability) --------------
destination=[
{"type":"timebased","period":{"weekdays":"1|2|3","start":0,"end":1440},
"stages":[[{"addr":"oncall0","method":"","comment":"","type":"group"}]]},
{"type":"timebased","period":{"weekdays":"1|2|3|4|5|6|7","start":360,"end":1050},
"stages":[[{"addr":"oncall0","method":"","comment":"","type":"group"}]]}]
----------------------------------------------------------------------------