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": "e1020b8d-d03a-413b-9725-cd138aedb345",
    "type": "playbooks",
    "attributes": {
      "title": "How to handle customer-facing incident?",
      "summary": "This is a summary",
      "external_url": null,
      "severity_ids": [],
      "environment_ids": [
        "275571db-2129-4047-a0cf-c27373ddde3d",
        "621c05da-213e-4d5d-b140-a7155674aa1f"
      ],
      "service_ids": [
        "8d875b96-1dd6-4f0b-bff0-623eb67da761",
        "a30feead-b4ab-4ef9-ba4e-6129b2025cab"
      ],
      "functionality_ids": [
        "5558c4c5-7838-4ecf-a3c2-3f20416ff6bf",
        "57627653-fa0b-4660-8850-afc2b9fc0749"
      ],
      "group_ids": [],
      "incident_type_ids": [],
      "cause_ids": [],
      "created_at": "2026-02-09T06:26:39.108-08:00",
      "updated_at": "2026-02-09T06:26:39.108-08:00"
    },
    "relationships": {
      "severities": {
        "data": []
      },
      "environments": {
        "data": [
          {
            "id": "275571db-2129-4047-a0cf-c27373ddde3d",
            "type": "environments"
          },
          {
            "id": "621c05da-213e-4d5d-b140-a7155674aa1f",
            "type": "environments"
          }
        ]
      },
      "services": {
        "data": [
          {
            "id": "8d875b96-1dd6-4f0b-bff0-623eb67da761",
            "type": "services"
          },
          {
            "id": "a30feead-b4ab-4ef9-ba4e-6129b2025cab",
            "type": "services"
          }
        ]
      },
      "functionalities": {
        "data": [
          {
            "id": "5558c4c5-7838-4ecf-a3c2-3f20416ff6bf",
            "type": "functionalities"
          },
          {
            "id": "57627653-fa0b-4660-8850-afc2b9fc0749",
            "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