Skip to main content
POST
/
v1
/
playbooks
Creates a playbook
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": "95eed814-1cc3-48fd-864f-bbbe50199e74",
    "type": "playbooks",
    "attributes": {
      "title": "How to handle customer-facing incident?",
      "summary": "This is a summary",
      "external_url": null,
      "severity_ids": [],
      "environment_ids": [
        "2a06dbbc-7bdf-4a77-926a-9a69804a9623",
        "38f87100-10d3-4f77-86e5-cdaf7d5cf883"
      ],
      "service_ids": [
        "315b6cd0-a2be-4bcf-9403-d1463cb7ad71",
        "a642ccd7-3c2a-42f3-bfee-7a23dc98125d"
      ],
      "functionality_ids": [
        "c6320cc0-d836-49e6-a045-1974f034803c",
        "8c1fa2fc-28ce-4e98-9216-4917ffeaa16f"
      ],
      "group_ids": [],
      "incident_type_ids": [],
      "cause_ids": [],
      "created_at": "2026-02-05T01:52:19.111-08:00",
      "updated_at": "2026-02-05T01:52:19.111-08:00"
    },
    "relationships": {
      "severities": {
        "data": []
      },
      "environments": {
        "data": [
          {
            "id": "2a06dbbc-7bdf-4a77-926a-9a69804a9623",
            "type": "environments"
          },
          {
            "id": "38f87100-10d3-4f77-86e5-cdaf7d5cf883",
            "type": "environments"
          }
        ]
      },
      "services": {
        "data": [
          {
            "id": "315b6cd0-a2be-4bcf-9403-d1463cb7ad71",
            "type": "services"
          },
          {
            "id": "a642ccd7-3c2a-42f3-bfee-7a23dc98125d",
            "type": "services"
          }
        ]
      },
      "functionalities": {
        "data": [
          {
            "id": "c6320cc0-d836-49e6-a045-1974f034803c",
            "type": "functionalities"
          },
          {
            "id": "8c1fa2fc-28ce-4e98-9216-4917ffeaa16f",
            "type": "functionalities"
          }
        ]
      },
      "groups": {
        "data": []
      },
      "causes": {
        "data": []
      },
      "incident_types": {
        "data": []
      }
    }
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/vnd.api+json
data
object
required

Response

playbook created

data
object
required