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": "e48c79e7-e4c0-46e3-a71d-bd4af8477be6",
    "type": "playbooks",
    "attributes": {
      "title": "How to handle customer-facing incident?",
      "summary": "This is a summary",
      "external_url": null,
      "severity_ids": [],
      "environment_ids": [
        "540b00d5-16e5-4082-bbdf-21cc26083814",
        "d0eded6c-bb41-4c5b-8597-efdffc0dba48"
      ],
      "service_ids": [
        "9f684419-bdaf-4518-bb94-f38e1c99657e",
        "4ab4eb76-3604-413b-8a3a-d1dc75f45720"
      ],
      "functionality_ids": [
        "b7d6baee-216d-4b04-985f-096d5a7659ee",
        "dc5f8c69-e856-4f48-b445-2fc3baf584ae"
      ],
      "group_ids": [],
      "incident_type_ids": [],
      "cause_ids": [],
      "created_at": "2025-12-12T08:03:33.505-08:00",
      "updated_at": "2025-12-12T08:03:33.505-08:00"
    },
    "relationships": {
      "severities": {
        "data": []
      },
      "environments": {
        "data": [
          {
            "id": "540b00d5-16e5-4082-bbdf-21cc26083814",
            "type": "environments"
          },
          {
            "id": "d0eded6c-bb41-4c5b-8597-efdffc0dba48",
            "type": "environments"
          }
        ]
      },
      "services": {
        "data": [
          {
            "id": "9f684419-bdaf-4518-bb94-f38e1c99657e",
            "type": "services"
          },
          {
            "id": "4ab4eb76-3604-413b-8a3a-d1dc75f45720",
            "type": "services"
          }
        ]
      },
      "functionalities": {
        "data": [
          {
            "id": "b7d6baee-216d-4b04-985f-096d5a7659ee",
            "type": "functionalities"
          },
          {
            "id": "dc5f8c69-e856-4f48-b445-2fc3baf584ae",
            "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