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": "5f012978-f13c-4afc-93df-4bde967031df",
    "type": "playbooks",
    "attributes": {
      "title": "How to handle customer-facing incident?",
      "summary": "This is a summary",
      "external_url": null,
      "severity_ids": [],
      "environment_ids": [
        "70cf1c02-2e96-4544-98ad-e7be5690ea5d",
        "5c136c7a-23d2-48bc-86ea-2640c2754afe"
      ],
      "service_ids": [
        "83474d27-8a72-4d67-a611-2c5331a15b99",
        "c4873603-51d7-4f98-b5fe-5320536728c5"
      ],
      "functionality_ids": [
        "c70fed5a-650b-48b2-a233-2bdcf351fcbd",
        "60ec714f-2070-49f1-9be7-ce8fa80f78c8"
      ],
      "group_ids": [],
      "incident_type_ids": [],
      "cause_ids": [],
      "created_at": "2026-02-18T18:59:26.971-08:00",
      "updated_at": "2026-02-18T18:59:26.971-08:00"
    },
    "relationships": {
      "severities": {
        "data": []
      },
      "environments": {
        "data": [
          {
            "id": "70cf1c02-2e96-4544-98ad-e7be5690ea5d",
            "type": "environments"
          },
          {
            "id": "5c136c7a-23d2-48bc-86ea-2640c2754afe",
            "type": "environments"
          }
        ]
      },
      "services": {
        "data": [
          {
            "id": "83474d27-8a72-4d67-a611-2c5331a15b99",
            "type": "services"
          },
          {
            "id": "c4873603-51d7-4f98-b5fe-5320536728c5",
            "type": "services"
          }
        ]
      },
      "functionalities": {
        "data": [
          {
            "id": "c70fed5a-650b-48b2-a233-2bdcf351fcbd",
            "type": "functionalities"
          },
          {
            "id": "60ec714f-2070-49f1-9be7-ce8fa80f78c8",
            "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