Plan an escalation timeline
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/oncall/escalation/plan \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"policy": {
"steps": [
{
"target": {
"type": "rotation",
"rotation": {
"members": [
"<string>"
],
"anchor": "2023-11-07T05:31:56Z",
"name": "<string>",
"cadence": "weekly",
"shift_length_seconds": 123
}
},
"channels": [],
"escalate_after_seconds": 300
}
],
"name": "<string>",
"repeat": 0
},
"start_at": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/oncall/escalation/plan"
payload = {
"policy": {
"steps": [
{
"target": {
"type": "rotation",
"rotation": {
"members": ["<string>"],
"anchor": "2023-11-07T05:31:56Z",
"name": "<string>",
"cadence": "weekly",
"shift_length_seconds": 123
}
},
"channels": [],
"escalate_after_seconds": 300
}
],
"name": "<string>",
"repeat": 0
},
"start_at": "2023-11-07T05:31:56Z"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
policy: {
steps: [
{
target: {
type: 'rotation',
rotation: {
members: ['<string>'],
anchor: '2023-11-07T05:31:56Z',
name: '<string>',
cadence: 'weekly',
shift_length_seconds: 123
}
},
channels: [],
escalate_after_seconds: 300
}
],
name: '<string>',
repeat: 0
},
start_at: '2023-11-07T05:31:56Z'
})
};
fetch('https://api.orbit.devotel.io/api/v1/oncall/escalation/plan', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.orbit.devotel.io/api/v1/oncall/escalation/plan",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'policy' => [
'steps' => [
[
'target' => [
'type' => 'rotation',
'rotation' => [
'members' => [
'<string>'
],
'anchor' => '2023-11-07T05:31:56Z',
'name' => '<string>',
'cadence' => 'weekly',
'shift_length_seconds' => 123
]
],
'channels' => [
],
'escalate_after_seconds' => 300
]
],
'name' => '<string>',
'repeat' => 0
],
'start_at' => '2023-11-07T05:31:56Z'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.orbit.devotel.io/api/v1/oncall/escalation/plan"
payload := strings.NewReader("{\n \"policy\": {\n \"steps\": [\n {\n \"target\": {\n \"type\": \"rotation\",\n \"rotation\": {\n \"members\": [\n \"<string>\"\n ],\n \"anchor\": \"2023-11-07T05:31:56Z\",\n \"name\": \"<string>\",\n \"cadence\": \"weekly\",\n \"shift_length_seconds\": 123\n }\n },\n \"channels\": [],\n \"escalate_after_seconds\": 300\n }\n ],\n \"name\": \"<string>\",\n \"repeat\": 0\n },\n \"start_at\": \"2023-11-07T05:31:56Z\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.orbit.devotel.io/api/v1/oncall/escalation/plan")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"policy\": {\n \"steps\": [\n {\n \"target\": {\n \"type\": \"rotation\",\n \"rotation\": {\n \"members\": [\n \"<string>\"\n ],\n \"anchor\": \"2023-11-07T05:31:56Z\",\n \"name\": \"<string>\",\n \"cadence\": \"weekly\",\n \"shift_length_seconds\": 123\n }\n },\n \"channels\": [],\n \"escalate_after_seconds\": 300\n }\n ],\n \"name\": \"<string>\",\n \"repeat\": 0\n },\n \"start_at\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/oncall/escalation/plan")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"policy\": {\n \"steps\": [\n {\n \"target\": {\n \"type\": \"rotation\",\n \"rotation\": {\n \"members\": [\n \"<string>\"\n ],\n \"anchor\": \"2023-11-07T05:31:56Z\",\n \"name\": \"<string>\",\n \"cadence\": \"weekly\",\n \"shift_length_seconds\": 123\n }\n },\n \"channels\": [],\n \"escalate_after_seconds\": 300\n }\n ],\n \"name\": \"<string>\",\n \"repeat\": 0\n },\n \"start_at\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"policy_name": "<string>",
"start_at": "2023-11-07T05:31:56Z",
"total_pages": 123,
"pages": [
{
"round": 123,
"step": 123,
"offset_seconds": 123,
"fire_at": "2023-11-07T05:31:56Z",
"targets": [
"<string>"
],
"channels": []
}
]
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}OnCall
Plan an escalation timeline
Flatten an escalation policy into the ordered page timeline showing all targets, channels, and offsets an incident driver would walk. The timeline is anchored at a given incident start instant (defaults to now). Pure compute — no pages are actually sent.
POST
/
api
/
v1
/
oncall
/
escalation
/
plan
Plan an escalation timeline
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/oncall/escalation/plan \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"policy": {
"steps": [
{
"target": {
"type": "rotation",
"rotation": {
"members": [
"<string>"
],
"anchor": "2023-11-07T05:31:56Z",
"name": "<string>",
"cadence": "weekly",
"shift_length_seconds": 123
}
},
"channels": [],
"escalate_after_seconds": 300
}
],
"name": "<string>",
"repeat": 0
},
"start_at": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/oncall/escalation/plan"
payload = {
"policy": {
"steps": [
{
"target": {
"type": "rotation",
"rotation": {
"members": ["<string>"],
"anchor": "2023-11-07T05:31:56Z",
"name": "<string>",
"cadence": "weekly",
"shift_length_seconds": 123
}
},
"channels": [],
"escalate_after_seconds": 300
}
],
"name": "<string>",
"repeat": 0
},
"start_at": "2023-11-07T05:31:56Z"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
policy: {
steps: [
{
target: {
type: 'rotation',
rotation: {
members: ['<string>'],
anchor: '2023-11-07T05:31:56Z',
name: '<string>',
cadence: 'weekly',
shift_length_seconds: 123
}
},
channels: [],
escalate_after_seconds: 300
}
],
name: '<string>',
repeat: 0
},
start_at: '2023-11-07T05:31:56Z'
})
};
fetch('https://api.orbit.devotel.io/api/v1/oncall/escalation/plan', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.orbit.devotel.io/api/v1/oncall/escalation/plan",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'policy' => [
'steps' => [
[
'target' => [
'type' => 'rotation',
'rotation' => [
'members' => [
'<string>'
],
'anchor' => '2023-11-07T05:31:56Z',
'name' => '<string>',
'cadence' => 'weekly',
'shift_length_seconds' => 123
]
],
'channels' => [
],
'escalate_after_seconds' => 300
]
],
'name' => '<string>',
'repeat' => 0
],
'start_at' => '2023-11-07T05:31:56Z'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.orbit.devotel.io/api/v1/oncall/escalation/plan"
payload := strings.NewReader("{\n \"policy\": {\n \"steps\": [\n {\n \"target\": {\n \"type\": \"rotation\",\n \"rotation\": {\n \"members\": [\n \"<string>\"\n ],\n \"anchor\": \"2023-11-07T05:31:56Z\",\n \"name\": \"<string>\",\n \"cadence\": \"weekly\",\n \"shift_length_seconds\": 123\n }\n },\n \"channels\": [],\n \"escalate_after_seconds\": 300\n }\n ],\n \"name\": \"<string>\",\n \"repeat\": 0\n },\n \"start_at\": \"2023-11-07T05:31:56Z\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.orbit.devotel.io/api/v1/oncall/escalation/plan")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"policy\": {\n \"steps\": [\n {\n \"target\": {\n \"type\": \"rotation\",\n \"rotation\": {\n \"members\": [\n \"<string>\"\n ],\n \"anchor\": \"2023-11-07T05:31:56Z\",\n \"name\": \"<string>\",\n \"cadence\": \"weekly\",\n \"shift_length_seconds\": 123\n }\n },\n \"channels\": [],\n \"escalate_after_seconds\": 300\n }\n ],\n \"name\": \"<string>\",\n \"repeat\": 0\n },\n \"start_at\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/oncall/escalation/plan")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"policy\": {\n \"steps\": [\n {\n \"target\": {\n \"type\": \"rotation\",\n \"rotation\": {\n \"members\": [\n \"<string>\"\n ],\n \"anchor\": \"2023-11-07T05:31:56Z\",\n \"name\": \"<string>\",\n \"cadence\": \"weekly\",\n \"shift_length_seconds\": 123\n }\n },\n \"channels\": [],\n \"escalate_after_seconds\": 300\n }\n ],\n \"name\": \"<string>\",\n \"repeat\": 0\n },\n \"start_at\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"policy_name": "<string>",
"start_at": "2023-11-07T05:31:56Z",
"total_pages": 123,
"pages": [
{
"round": 123,
"step": 123,
"offset_seconds": 123,
"fire_at": "2023-11-07T05:31:56Z",
"targets": [
"<string>"
],
"channels": []
}
]
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}Authorizations
BearerApiKey
Dashboard JWT token from Clerk
Body
application/json
⌘I