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": "b0d33298-8310-4486-8c83-6121cc182868",
    "type": "playbooks",
    "attributes": {
      "title": "How to handle customer-facing incident?",
      "summary": "This is a summary",
      "external_url": null,
      "severity_ids": [],
      "environment_ids": [
        "1bee73b3-90af-4268-8261-b505f556dd6a",
        "cf34529d-6007-493d-a90b-7c6efd4cb244"
      ],
      "service_ids": [
        "e567e4ff-3ed2-4425-99bb-27da959a88f2",
        "1a05093a-942a-4ed6-a60a-90802d71f005"
      ],
      "functionality_ids": [
        "33b8216f-e935-4779-abbc-9a956db2cd20",
        "34c3ca3e-3af6-464e-b492-1d8a653f7e10"
      ],
      "group_ids": [],
      "incident_type_ids": [],
      "cause_ids": [],
      "created_at": "2026-02-03T09:35:18.568-08:00",
      "updated_at": "2026-02-03T09:35:18.568-08:00"
    },
    "relationships": {
      "severities": {
        "data": []
      },
      "environments": {
        "data": [
          {
            "id": "1bee73b3-90af-4268-8261-b505f556dd6a",
            "type": "environments"
          },
          {
            "id": "cf34529d-6007-493d-a90b-7c6efd4cb244",
            "type": "environments"
          }
        ]
      },
      "services": {
        "data": [
          {
            "id": "e567e4ff-3ed2-4425-99bb-27da959a88f2",
            "type": "services"
          },
          {
            "id": "1a05093a-942a-4ed6-a60a-90802d71f005",
            "type": "services"
          }
        ]
      },
      "functionalities": {
        "data": [
          {
            "id": "33b8216f-e935-4779-abbc-9a956db2cd20",
            "type": "functionalities"
          },
          {
            "id": "34c3ca3e-3af6-464e-b492-1d8a653f7e10",
            "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