Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/vnd.api+json
Response
playbook created
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": "bfb63195-c48c-4a31-adbb-2c865ebab288",
"type": "playbooks",
"attributes": {
"title": "How to handle customer-facing incident?",
"summary": "This is a summary",
"external_url": null,
"severity_ids": [],
"environment_ids": [
"299afb13-9e4c-4056-b5d4-bdcfce60cbdf",
"99fd4916-9777-4a29-a5a6-e8ad9749a104"
],
"service_ids": [
"15ce142f-0242-434a-b460-8d9062a5b8f3",
"e9ed29b5-6757-4283-a769-23c5cb4f8eb3"
],
"functionality_ids": [
"c95c2cfc-a4f9-45fd-9eea-8da604d84309",
"2799db60-56a9-4a14-a60d-1592796285e5"
],
"group_ids": [],
"incident_type_ids": [],
"cause_ids": [],
"created_at": "2025-12-03T21:32:13.245-08:00",
"updated_at": "2025-12-03T21:32:13.245-08:00"
},
"relationships": {
"severities": {
"data": []
},
"environments": {
"data": [
{
"id": "299afb13-9e4c-4056-b5d4-bdcfce60cbdf",
"type": "environments"
},
{
"id": "99fd4916-9777-4a29-a5a6-e8ad9749a104",
"type": "environments"
}
]
},
"services": {
"data": [
{
"id": "15ce142f-0242-434a-b460-8d9062a5b8f3",
"type": "services"
},
{
"id": "e9ed29b5-6757-4283-a769-23c5cb4f8eb3",
"type": "services"
}
]
},
"functionalities": {
"data": [
{
"id": "c95c2cfc-a4f9-45fd-9eea-8da604d84309",
"type": "functionalities"
},
{
"id": "2799db60-56a9-4a14-a60d-1592796285e5",
"type": "functionalities"
}
]
},
"groups": {
"data": []
},
"causes": {
"data": []
},
"incident_types": {
"data": []
}
}
}
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Show child attributes
playbook created
Show child attributes
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": "bfb63195-c48c-4a31-adbb-2c865ebab288",
"type": "playbooks",
"attributes": {
"title": "How to handle customer-facing incident?",
"summary": "This is a summary",
"external_url": null,
"severity_ids": [],
"environment_ids": [
"299afb13-9e4c-4056-b5d4-bdcfce60cbdf",
"99fd4916-9777-4a29-a5a6-e8ad9749a104"
],
"service_ids": [
"15ce142f-0242-434a-b460-8d9062a5b8f3",
"e9ed29b5-6757-4283-a769-23c5cb4f8eb3"
],
"functionality_ids": [
"c95c2cfc-a4f9-45fd-9eea-8da604d84309",
"2799db60-56a9-4a14-a60d-1592796285e5"
],
"group_ids": [],
"incident_type_ids": [],
"cause_ids": [],
"created_at": "2025-12-03T21:32:13.245-08:00",
"updated_at": "2025-12-03T21:32:13.245-08:00"
},
"relationships": {
"severities": {
"data": []
},
"environments": {
"data": [
{
"id": "299afb13-9e4c-4056-b5d4-bdcfce60cbdf",
"type": "environments"
},
{
"id": "99fd4916-9777-4a29-a5a6-e8ad9749a104",
"type": "environments"
}
]
},
"services": {
"data": [
{
"id": "15ce142f-0242-434a-b460-8d9062a5b8f3",
"type": "services"
},
{
"id": "e9ed29b5-6757-4283-a769-23c5cb4f8eb3",
"type": "services"
}
]
},
"functionalities": {
"data": [
{
"id": "c95c2cfc-a4f9-45fd-9eea-8da604d84309",
"type": "functionalities"
},
{
"id": "2799db60-56a9-4a14-a60d-1592796285e5",
"type": "functionalities"
}
]
},
"groups": {
"data": []
},
"causes": {
"data": []
},
"incident_types": {
"data": []
}
}
}
}