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": "3963c7c4-13fc-49d5-a42f-41f66a4ca3c2",
    "type": "playbooks",
    "attributes": {
      "title": "How to handle customer-facing incident?",
      "summary": "This is a summary",
      "external_url": null,
      "severity_ids": [],
      "environment_ids": [
        "721d896d-1e28-47f0-a325-cfd49c72b766",
        "869966d3-2c7b-44c5-806c-153872f16ae0"
      ],
      "service_ids": [
        "6d2636b0-3ded-4c44-bf56-64b2106f7e3a",
        "683c887d-7e06-4ce1-959e-2d506fcfa600"
      ],
      "functionality_ids": [
        "b9eb7a69-74a2-4d95-b9d5-980c1ccb9e52",
        "469c3d9c-2105-4448-8063-8fbe57babfed"
      ],
      "group_ids": [],
      "incident_type_ids": [],
      "cause_ids": [],
      "created_at": "2025-11-27T00:11:33.392-08:00",
      "updated_at": "2025-11-27T00:11:33.392-08:00"
    },
    "relationships": {
      "severities": {
        "data": []
      },
      "environments": {
        "data": [
          {
            "id": "721d896d-1e28-47f0-a325-cfd49c72b766",
            "type": "environments"
          },
          {
            "id": "869966d3-2c7b-44c5-806c-153872f16ae0",
            "type": "environments"
          }
        ]
      },
      "services": {
        "data": [
          {
            "id": "6d2636b0-3ded-4c44-bf56-64b2106f7e3a",
            "type": "services"
          },
          {
            "id": "683c887d-7e06-4ce1-959e-2d506fcfa600",
            "type": "services"
          }
        ]
      },
      "functionalities": {
        "data": [
          {
            "id": "b9eb7a69-74a2-4d95-b9d5-980c1ccb9e52",
            "type": "functionalities"
          },
          {
            "id": "469c3d9c-2105-4448-8063-8fbe57babfed",
            "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