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": "428bfbc5-901f-4ee5-b369-64a41b8821c2",
    "type": "playbooks",
    "attributes": {
      "title": "How to handle customer-facing incident?",
      "summary": "This is a summary",
      "external_url": null,
      "severity_ids": [],
      "environment_ids": [
        "3e6fa430-ef9c-4873-a893-dd30e68532a1",
        "18fcc8a7-e861-4bd0-acfc-a031e946591e"
      ],
      "service_ids": [
        "27ac1598-3a2b-4091-9189-bcd2d25d3fd2",
        "3f3d10dd-868c-4e8f-b5e1-0d80e53116d9"
      ],
      "functionality_ids": [
        "825486a3-33c4-4fba-8c9e-3d9aba849811",
        "bc5bca1e-7b03-4bed-9c49-ee96b1eceda5"
      ],
      "group_ids": [],
      "incident_type_ids": [],
      "cause_ids": [],
      "created_at": "2026-02-13T08:42:08.340-08:00",
      "updated_at": "2026-02-13T08:42:08.340-08:00"
    },
    "relationships": {
      "severities": {
        "data": []
      },
      "environments": {
        "data": [
          {
            "id": "3e6fa430-ef9c-4873-a893-dd30e68532a1",
            "type": "environments"
          },
          {
            "id": "18fcc8a7-e861-4bd0-acfc-a031e946591e",
            "type": "environments"
          }
        ]
      },
      "services": {
        "data": [
          {
            "id": "27ac1598-3a2b-4091-9189-bcd2d25d3fd2",
            "type": "services"
          },
          {
            "id": "3f3d10dd-868c-4e8f-b5e1-0d80e53116d9",
            "type": "services"
          }
        ]
      },
      "functionalities": {
        "data": [
          {
            "id": "825486a3-33c4-4fba-8c9e-3d9aba849811",
            "type": "functionalities"
          },
          {
            "id": "bc5bca1e-7b03-4bed-9c49-ee96b1eceda5",
            "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