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": "4fd5b5bc-6ecc-4f2c-9844-5d2ad78b2c35",
"type": "playbooks",
"attributes": {
"title": "How to handle customer-facing incident?",
"summary": "This is a summary",
"external_url": null,
"severity_ids": [],
"environment_ids": [
"dffd8dbf-dc22-447c-adaf-9ffa061fe2ed",
"ef83831c-0902-4285-b0ab-348b9c1e33d9"
],
"service_ids": [
"ffee4953-6b29-4c78-bd7e-cc5c52751202",
"5567ea9a-48f6-4a55-84ca-b32ba46c29d5"
],
"functionality_ids": [
"c38a3399-e675-4749-9d2d-4e709293acf1",
"7cd1601f-37f3-4bc9-a32c-db6b1b208e82"
],
"group_ids": [],
"incident_type_ids": [],
"cause_ids": [],
"created_at": "2025-12-04T21:53:35.813-08:00",
"updated_at": "2025-12-04T21:53:35.813-08:00"
},
"relationships": {
"severities": {
"data": []
},
"environments": {
"data": [
{
"id": "dffd8dbf-dc22-447c-adaf-9ffa061fe2ed",
"type": "environments"
},
{
"id": "ef83831c-0902-4285-b0ab-348b9c1e33d9",
"type": "environments"
}
]
},
"services": {
"data": [
{
"id": "ffee4953-6b29-4c78-bd7e-cc5c52751202",
"type": "services"
},
{
"id": "5567ea9a-48f6-4a55-84ca-b32ba46c29d5",
"type": "services"
}
]
},
"functionalities": {
"data": [
{
"id": "c38a3399-e675-4749-9d2d-4e709293acf1",
"type": "functionalities"
},
{
"id": "7cd1601f-37f3-4bc9-a32c-db6b1b208e82",
"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
playbooks Show child attributes
The title of the playbook
The summary of the playbook
The external url of the playbook
The Severity ID's to attach to the incident
The Environment ID's to attach to the incident
The Service ID's to attach to the incident
The Functionality ID's to attach to the incident
The Team ID's to attach to the incident
The Incident Type ID's to attach to the incident
playbook created
Show child attributes
Unique ID of the playbook
playbooks Show child attributes
The title of the playbook
Date of creation
Date of last update
The summary of the playbook
The external url of the playbook
The Severity ID's to attach to the incident
The Environment ID's to attach to the incident
The Functionality ID's to attach to the incident
The Service ID's to attach to the incident
The Team ID's to attach to the incident
The Incident Type ID's to attach to the incident
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": "4fd5b5bc-6ecc-4f2c-9844-5d2ad78b2c35",
"type": "playbooks",
"attributes": {
"title": "How to handle customer-facing incident?",
"summary": "This is a summary",
"external_url": null,
"severity_ids": [],
"environment_ids": [
"dffd8dbf-dc22-447c-adaf-9ffa061fe2ed",
"ef83831c-0902-4285-b0ab-348b9c1e33d9"
],
"service_ids": [
"ffee4953-6b29-4c78-bd7e-cc5c52751202",
"5567ea9a-48f6-4a55-84ca-b32ba46c29d5"
],
"functionality_ids": [
"c38a3399-e675-4749-9d2d-4e709293acf1",
"7cd1601f-37f3-4bc9-a32c-db6b1b208e82"
],
"group_ids": [],
"incident_type_ids": [],
"cause_ids": [],
"created_at": "2025-12-04T21:53:35.813-08:00",
"updated_at": "2025-12-04T21:53:35.813-08:00"
},
"relationships": {
"severities": {
"data": []
},
"environments": {
"data": [
{
"id": "dffd8dbf-dc22-447c-adaf-9ffa061fe2ed",
"type": "environments"
},
{
"id": "ef83831c-0902-4285-b0ab-348b9c1e33d9",
"type": "environments"
}
]
},
"services": {
"data": [
{
"id": "ffee4953-6b29-4c78-bd7e-cc5c52751202",
"type": "services"
},
{
"id": "5567ea9a-48f6-4a55-84ca-b32ba46c29d5",
"type": "services"
}
]
},
"functionalities": {
"data": [
{
"id": "c38a3399-e675-4749-9d2d-4e709293acf1",
"type": "functionalities"
},
{
"id": "7cd1601f-37f3-4bc9-a32c-db6b1b208e82",
"type": "functionalities"
}
]
},
"groups": {
"data": []
},
"causes": {
"data": []
},
"incident_types": {
"data": []
}
}
}
}