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": "28c025b2-4acd-4485-b4a8-5193fb63f011",
    "type": "playbooks",
    "attributes": {
      "title": "How to handle customer-facing incident?",
      "summary": "This is a summary",
      "external_url": null,
      "severity_ids": [],
      "environment_ids": [
        "fe77a469-5f3d-4ff5-8f32-07abca14f308",
        "96759d51-eecb-43ea-8018-55c5ad780d00"
      ],
      "service_ids": [
        "c2f749d3-1117-4419-b489-f0361eedd1a9",
        "8621a9ab-886c-48d6-b4a9-efc3f4849367"
      ],
      "functionality_ids": [
        "9e5a79af-984a-4a61-8121-526004f2128e",
        "387342e7-5f53-4530-b19b-f7f231765e53"
      ],
      "group_ids": [],
      "incident_type_ids": [],
      "cause_ids": [],
      "created_at": "2025-12-19T09:36:23.502-08:00",
      "updated_at": "2025-12-19T09:36:23.502-08:00"
    },
    "relationships": {
      "severities": {
        "data": []
      },
      "environments": {
        "data": [
          {
            "id": "fe77a469-5f3d-4ff5-8f32-07abca14f308",
            "type": "environments"
          },
          {
            "id": "96759d51-eecb-43ea-8018-55c5ad780d00",
            "type": "environments"
          }
        ]
      },
      "services": {
        "data": [
          {
            "id": "c2f749d3-1117-4419-b489-f0361eedd1a9",
            "type": "services"
          },
          {
            "id": "8621a9ab-886c-48d6-b4a9-efc3f4849367",
            "type": "services"
          }
        ]
      },
      "functionalities": {
        "data": [
          {
            "id": "9e5a79af-984a-4a61-8121-526004f2128e",
            "type": "functionalities"
          },
          {
            "id": "387342e7-5f53-4530-b19b-f7f231765e53",
            "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