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": "295ade89-e038-45df-a983-9113b6690017",
    "type": "playbooks",
    "attributes": {
      "title": "How to handle customer-facing incident?",
      "summary": "This is a summary",
      "external_url": null,
      "severity_ids": [],
      "environment_ids": [
        "02fa633d-bbca-4894-b6a7-f9ded93860d3",
        "0c17c045-26fb-4c29-87ed-1d9d0f3574d8"
      ],
      "service_ids": [
        "bd8d3d56-48f4-4200-b181-0dc84c5e6cff",
        "3e3c6254-afea-4be5-9621-264ddb216006"
      ],
      "functionality_ids": [
        "17c2cf22-c50f-4430-9fca-9db9991c784e",
        "76ed4fef-393b-4e9e-885e-4eb4c0f39bfc"
      ],
      "group_ids": [],
      "incident_type_ids": [],
      "cause_ids": [],
      "created_at": "2026-02-13T18:09:18.787-08:00",
      "updated_at": "2026-02-13T18:09:18.787-08:00"
    },
    "relationships": {
      "severities": {
        "data": []
      },
      "environments": {
        "data": [
          {
            "id": "02fa633d-bbca-4894-b6a7-f9ded93860d3",
            "type": "environments"
          },
          {
            "id": "0c17c045-26fb-4c29-87ed-1d9d0f3574d8",
            "type": "environments"
          }
        ]
      },
      "services": {
        "data": [
          {
            "id": "bd8d3d56-48f4-4200-b181-0dc84c5e6cff",
            "type": "services"
          },
          {
            "id": "3e3c6254-afea-4be5-9621-264ddb216006",
            "type": "services"
          }
        ]
      },
      "functionalities": {
        "data": [
          {
            "id": "17c2cf22-c50f-4430-9fca-9db9991c784e",
            "type": "functionalities"
          },
          {
            "id": "76ed4fef-393b-4e9e-885e-4eb4c0f39bfc",
            "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