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": "1075141d-7f19-4b0b-b56b-9b6911bb280b",
"type": "playbooks",
"attributes": {
"title": "How to handle customer-facing incident?",
"summary": "This is a summary",
"external_url": null,
"severity_ids": [],
"environment_ids": [
"ba493ee1-8aac-49ac-a0d0-6dc9d9d72bbf",
"51dfcd5c-c013-43b2-b92d-d2cbe0d18eae"
],
"service_ids": [
"c7971bc0-228a-424d-8d3a-c588d6056796",
"f473ac76-8a78-44e4-9de3-18c968cee6b0"
],
"functionality_ids": [
"e735443e-e669-4371-b96f-0a44f92cb8f0",
"d9f41918-458d-4846-b5df-986467fa2e5f"
],
"group_ids": [],
"incident_type_ids": [],
"cause_ids": [],
"created_at": "2025-08-19T10:24:04.900-07:00",
"updated_at": "2025-08-19T10:24:04.900-07:00"
},
"relationships": {
"severities": {
"data": []
},
"environments": {
"data": [
{
"id": "ba493ee1-8aac-49ac-a0d0-6dc9d9d72bbf",
"type": "environments"
},
{
"id": "51dfcd5c-c013-43b2-b92d-d2cbe0d18eae",
"type": "environments"
}
]
},
"services": {
"data": [
{
"id": "c7971bc0-228a-424d-8d3a-c588d6056796",
"type": "services"
},
{
"id": "f473ac76-8a78-44e4-9de3-18c968cee6b0",
"type": "services"
}
]
},
"functionalities": {
"data": [
{
"id": "e735443e-e669-4371-b96f-0a44f92cb8f0",
"type": "functionalities"
},
{
"id": "d9f41918-458d-4846-b5df-986467fa2e5f",
"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": "1075141d-7f19-4b0b-b56b-9b6911bb280b",
"type": "playbooks",
"attributes": {
"title": "How to handle customer-facing incident?",
"summary": "This is a summary",
"external_url": null,
"severity_ids": [],
"environment_ids": [
"ba493ee1-8aac-49ac-a0d0-6dc9d9d72bbf",
"51dfcd5c-c013-43b2-b92d-d2cbe0d18eae"
],
"service_ids": [
"c7971bc0-228a-424d-8d3a-c588d6056796",
"f473ac76-8a78-44e4-9de3-18c968cee6b0"
],
"functionality_ids": [
"e735443e-e669-4371-b96f-0a44f92cb8f0",
"d9f41918-458d-4846-b5df-986467fa2e5f"
],
"group_ids": [],
"incident_type_ids": [],
"cause_ids": [],
"created_at": "2025-08-19T10:24:04.900-07:00",
"updated_at": "2025-08-19T10:24:04.900-07:00"
},
"relationships": {
"severities": {
"data": []
},
"environments": {
"data": [
{
"id": "ba493ee1-8aac-49ac-a0d0-6dc9d9d72bbf",
"type": "environments"
},
{
"id": "51dfcd5c-c013-43b2-b92d-d2cbe0d18eae",
"type": "environments"
}
]
},
"services": {
"data": [
{
"id": "c7971bc0-228a-424d-8d3a-c588d6056796",
"type": "services"
},
{
"id": "f473ac76-8a78-44e4-9de3-18c968cee6b0",
"type": "services"
}
]
},
"functionalities": {
"data": [
{
"id": "e735443e-e669-4371-b96f-0a44f92cb8f0",
"type": "functionalities"
},
{
"id": "d9f41918-458d-4846-b5df-986467fa2e5f",
"type": "functionalities"
}
]
},
"groups": {
"data": []
},
"causes": {
"data": []
},
"incident_types": {
"data": []
}
}
}
}