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": "6a53e4c9-931b-49b4-b4d6-f2daaf702110",
"type": "playbooks",
"attributes": {
"title": "How to handle customer-facing incident?",
"summary": "This is a summary",
"external_url": null,
"severity_ids": [],
"environment_ids": [
"46ef8667-9d5f-457f-9a63-948c10f60cc1",
"7dced087-659b-441f-845c-129cbc6a8673"
],
"service_ids": [
"d528b079-64b1-4b12-988a-ece6f3e1e377",
"7eceb20b-a3d4-40f4-bcc5-8e0eb1a692b2"
],
"functionality_ids": [
"76c02872-dc4e-4a9f-a1b3-5cb16f18ab9c",
"ac401ecc-771f-48b1-8958-cf62a7a4b041"
],
"group_ids": [],
"incident_type_ids": [],
"cause_ids": [],
"created_at": "2025-10-29T12:12:02.268-07:00",
"updated_at": "2025-10-29T12:12:02.268-07:00"
},
"relationships": {
"severities": {
"data": []
},
"environments": {
"data": [
{
"id": "46ef8667-9d5f-457f-9a63-948c10f60cc1",
"type": "environments"
},
{
"id": "7dced087-659b-441f-845c-129cbc6a8673",
"type": "environments"
}
]
},
"services": {
"data": [
{
"id": "d528b079-64b1-4b12-988a-ece6f3e1e377",
"type": "services"
},
{
"id": "7eceb20b-a3d4-40f4-bcc5-8e0eb1a692b2",
"type": "services"
}
]
},
"functionalities": {
"data": [
{
"id": "76c02872-dc4e-4a9f-a1b3-5cb16f18ab9c",
"type": "functionalities"
},
{
"id": "ac401ecc-771f-48b1-8958-cf62a7a4b041",
"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": "6a53e4c9-931b-49b4-b4d6-f2daaf702110",
"type": "playbooks",
"attributes": {
"title": "How to handle customer-facing incident?",
"summary": "This is a summary",
"external_url": null,
"severity_ids": [],
"environment_ids": [
"46ef8667-9d5f-457f-9a63-948c10f60cc1",
"7dced087-659b-441f-845c-129cbc6a8673"
],
"service_ids": [
"d528b079-64b1-4b12-988a-ece6f3e1e377",
"7eceb20b-a3d4-40f4-bcc5-8e0eb1a692b2"
],
"functionality_ids": [
"76c02872-dc4e-4a9f-a1b3-5cb16f18ab9c",
"ac401ecc-771f-48b1-8958-cf62a7a4b041"
],
"group_ids": [],
"incident_type_ids": [],
"cause_ids": [],
"created_at": "2025-10-29T12:12:02.268-07:00",
"updated_at": "2025-10-29T12:12:02.268-07:00"
},
"relationships": {
"severities": {
"data": []
},
"environments": {
"data": [
{
"id": "46ef8667-9d5f-457f-9a63-948c10f60cc1",
"type": "environments"
},
{
"id": "7dced087-659b-441f-845c-129cbc6a8673",
"type": "environments"
}
]
},
"services": {
"data": [
{
"id": "d528b079-64b1-4b12-988a-ece6f3e1e377",
"type": "services"
},
{
"id": "7eceb20b-a3d4-40f4-bcc5-8e0eb1a692b2",
"type": "services"
}
]
},
"functionalities": {
"data": [
{
"id": "76c02872-dc4e-4a9f-a1b3-5cb16f18ab9c",
"type": "functionalities"
},
{
"id": "ac401ecc-771f-48b1-8958-cf62a7a4b041",
"type": "functionalities"
}
]
},
"groups": {
"data": []
},
"causes": {
"data": []
},
"incident_types": {
"data": []
}
}
}
}