Creates a new playbook from provided data
curl --request POST \
--url https://api.rootly.com/v1/playbooks \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/vnd.api+json' \
--data '{
"data": {
"type": "playbooks",
"attributes": {
"title": "<string>",
"summary": "<string>",
"external_url": "<string>",
"severity_ids": [
"<string>"
],
"environment_ids": [
"<string>"
],
"service_ids": [
"<string>"
],
"functionality_ids": [
"<string>"
],
"group_ids": [
"<string>"
],
"incident_type_ids": [
"<string>"
]
}
}
}'
{
"data": {
"id": "cfe0e38b-08bf-4237-8f58-cbeec176787a",
"type": "playbooks",
"attributes": {
"title": "How to handle customer-facing incident?",
"summary": "This is a summary",
"external_url": null,
"severity_ids": [],
"environment_ids": [
"a4b08e16-f4c9-4765-9ea4-a9f6c021a51d",
"387021b6-331b-4777-b3e6-ccfb36aa66b5"
],
"service_ids": [
"e22583d5-97d0-4878-ae89-1c553e1bf79f",
"82334e44-275d-4bdb-a5fa-5280ce174b1a"
],
"functionality_ids": [
"12c03603-b3f4-4fb1-897d-b91ef3e94ed7",
"f641710d-5fde-4595-bdc3-c185e3137321"
],
"group_ids": [],
"incident_type_ids": [],
"cause_ids": [],
"created_at": "2025-07-30T02:13:26.082-07:00",
"updated_at": "2025-07-30T02:13:26.082-07:00"
},
"relationships": {
"severities": {
"data": []
},
"environments": {
"data": [
{
"id": "a4b08e16-f4c9-4765-9ea4-a9f6c021a51d",
"type": "environments"
},
{
"id": "387021b6-331b-4777-b3e6-ccfb36aa66b5",
"type": "environments"
}
]
},
"services": {
"data": [
{
"id": "e22583d5-97d0-4878-ae89-1c553e1bf79f",
"type": "services"
},
{
"id": "82334e44-275d-4bdb-a5fa-5280ce174b1a",
"type": "services"
}
]
},
"functionalities": {
"data": [
{
"id": "12c03603-b3f4-4fb1-897d-b91ef3e94ed7",
"type": "functionalities"
},
{
"id": "f641710d-5fde-4595-bdc3-c185e3137321",
"type": "functionalities"
}
]
},
"groups": {
"data": []
},
"causes": {
"data": []
},
"incident_types": {
"data": []
}
}
}
}
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
playbook created
The response is of type object
.
Was this page helpful?
curl --request POST \
--url https://api.rootly.com/v1/playbooks \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/vnd.api+json' \
--data '{
"data": {
"type": "playbooks",
"attributes": {
"title": "<string>",
"summary": "<string>",
"external_url": "<string>",
"severity_ids": [
"<string>"
],
"environment_ids": [
"<string>"
],
"service_ids": [
"<string>"
],
"functionality_ids": [
"<string>"
],
"group_ids": [
"<string>"
],
"incident_type_ids": [
"<string>"
]
}
}
}'
{
"data": {
"id": "cfe0e38b-08bf-4237-8f58-cbeec176787a",
"type": "playbooks",
"attributes": {
"title": "How to handle customer-facing incident?",
"summary": "This is a summary",
"external_url": null,
"severity_ids": [],
"environment_ids": [
"a4b08e16-f4c9-4765-9ea4-a9f6c021a51d",
"387021b6-331b-4777-b3e6-ccfb36aa66b5"
],
"service_ids": [
"e22583d5-97d0-4878-ae89-1c553e1bf79f",
"82334e44-275d-4bdb-a5fa-5280ce174b1a"
],
"functionality_ids": [
"12c03603-b3f4-4fb1-897d-b91ef3e94ed7",
"f641710d-5fde-4595-bdc3-c185e3137321"
],
"group_ids": [],
"incident_type_ids": [],
"cause_ids": [],
"created_at": "2025-07-30T02:13:26.082-07:00",
"updated_at": "2025-07-30T02:13:26.082-07:00"
},
"relationships": {
"severities": {
"data": []
},
"environments": {
"data": [
{
"id": "a4b08e16-f4c9-4765-9ea4-a9f6c021a51d",
"type": "environments"
},
{
"id": "387021b6-331b-4777-b3e6-ccfb36aa66b5",
"type": "environments"
}
]
},
"services": {
"data": [
{
"id": "e22583d5-97d0-4878-ae89-1c553e1bf79f",
"type": "services"
},
{
"id": "82334e44-275d-4bdb-a5fa-5280ce174b1a",
"type": "services"
}
]
},
"functionalities": {
"data": [
{
"id": "12c03603-b3f4-4fb1-897d-b91ef3e94ed7",
"type": "functionalities"
},
{
"id": "f641710d-5fde-4595-bdc3-c185e3137321",
"type": "functionalities"
}
]
},
"groups": {
"data": []
},
"causes": {
"data": []
},
"incident_types": {
"data": []
}
}
}
}