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": "29af8883-f1c0-4c8e-a32c-212bb4956766",
    "type": "playbooks",
    "attributes": {
      "title": "How to handle customer-facing incident?",
      "summary": "This is a summary",
      "external_url": null,
      "severity_ids": [],
      "environment_ids": [
        "542ba492-d294-40a4-a5e0-f5e3bf5c12de",
        "d1171e60-68d6-4ca8-84bd-227b265f2094"
      ],
      "service_ids": [
        "afa34808-18e0-4d01-8600-19dd24ed6eb7",
        "e8f003ba-17c3-480a-aa7c-7b9ba20b1fa2"
      ],
      "functionality_ids": [
        "315667b2-5770-4d15-a7e3-89e2051cd7b3",
        "d8b1a8c6-0e44-478b-9c7e-8a0dcaf8e73d"
      ],
      "group_ids": [],
      "incident_type_ids": [],
      "cause_ids": [],
      "created_at": "2026-02-02T19:54:51.491-08:00",
      "updated_at": "2026-02-02T19:54:51.491-08:00"
    },
    "relationships": {
      "severities": {
        "data": []
      },
      "environments": {
        "data": [
          {
            "id": "542ba492-d294-40a4-a5e0-f5e3bf5c12de",
            "type": "environments"
          },
          {
            "id": "d1171e60-68d6-4ca8-84bd-227b265f2094",
            "type": "environments"
          }
        ]
      },
      "services": {
        "data": [
          {
            "id": "afa34808-18e0-4d01-8600-19dd24ed6eb7",
            "type": "services"
          },
          {
            "id": "e8f003ba-17c3-480a-aa7c-7b9ba20b1fa2",
            "type": "services"
          }
        ]
      },
      "functionalities": {
        "data": [
          {
            "id": "315667b2-5770-4d15-a7e3-89e2051cd7b3",
            "type": "functionalities"
          },
          {
            "id": "d8b1a8c6-0e44-478b-9c7e-8a0dcaf8e73d",
            "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