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": "7d9cc5f1-d275-4605-9552-0844beff6be7",
    "type": "playbooks",
    "attributes": {
      "title": "How to handle customer-facing incident?",
      "summary": "This is a summary",
      "external_url": null,
      "severity_ids": [],
      "environment_ids": [
        "be2514fc-7e0a-4f65-9c12-f09f12a29abe",
        "a14550a3-1011-459e-ad13-d445f6adcd46"
      ],
      "service_ids": [
        "3086981b-cae2-4f3c-89d7-31091cb086b0",
        "dedf0592-6098-4992-8c62-0233162f26c7"
      ],
      "functionality_ids": [
        "f8c9b068-9aaa-4c44-832d-f47bfad23a1b",
        "8714a6d5-cfed-43f5-92fa-cec9621ef4e7"
      ],
      "group_ids": [],
      "incident_type_ids": [],
      "cause_ids": [],
      "created_at": "2026-02-12T08:07:32.350-08:00",
      "updated_at": "2026-02-12T08:07:32.350-08:00"
    },
    "relationships": {
      "severities": {
        "data": []
      },
      "environments": {
        "data": [
          {
            "id": "be2514fc-7e0a-4f65-9c12-f09f12a29abe",
            "type": "environments"
          },
          {
            "id": "a14550a3-1011-459e-ad13-d445f6adcd46",
            "type": "environments"
          }
        ]
      },
      "services": {
        "data": [
          {
            "id": "3086981b-cae2-4f3c-89d7-31091cb086b0",
            "type": "services"
          },
          {
            "id": "dedf0592-6098-4992-8c62-0233162f26c7",
            "type": "services"
          }
        ]
      },
      "functionalities": {
        "data": [
          {
            "id": "f8c9b068-9aaa-4c44-832d-f47bfad23a1b",
            "type": "functionalities"
          },
          {
            "id": "8714a6d5-cfed-43f5-92fa-cec9621ef4e7",
            "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