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": "e5236600-a2cf-4b95-a54e-13e45112d6e2",
    "type": "playbooks",
    "attributes": {
      "title": "How to handle customer-facing incident?",
      "summary": "This is a summary",
      "external_url": null,
      "severity_ids": [],
      "environment_ids": [
        "dab8e49e-ec7b-4892-8118-523e2aea6c1f",
        "f4fed1f7-170e-4765-b091-e2a3ca8091e6"
      ],
      "service_ids": [
        "368540e5-5e08-438a-a8ec-2fb3715c0d78",
        "9f3bea30-e9f6-472d-9c63-52d52b475608"
      ],
      "functionality_ids": [
        "5e080979-8678-4b7c-85f2-291c49cff84f",
        "34299ece-57fb-4320-afac-24bfbc138702"
      ],
      "group_ids": [],
      "incident_type_ids": [],
      "cause_ids": [],
      "created_at": "2026-02-06T06:18:59.621-08:00",
      "updated_at": "2026-02-06T06:18:59.621-08:00"
    },
    "relationships": {
      "severities": {
        "data": []
      },
      "environments": {
        "data": [
          {
            "id": "dab8e49e-ec7b-4892-8118-523e2aea6c1f",
            "type": "environments"
          },
          {
            "id": "f4fed1f7-170e-4765-b091-e2a3ca8091e6",
            "type": "environments"
          }
        ]
      },
      "services": {
        "data": [
          {
            "id": "368540e5-5e08-438a-a8ec-2fb3715c0d78",
            "type": "services"
          },
          {
            "id": "9f3bea30-e9f6-472d-9c63-52d52b475608",
            "type": "services"
          }
        ]
      },
      "functionalities": {
        "data": [
          {
            "id": "5e080979-8678-4b7c-85f2-291c49cff84f",
            "type": "functionalities"
          },
          {
            "id": "34299ece-57fb-4320-afac-24bfbc138702",
            "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