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": "847ee2a5-e906-44b3-bc6b-eb9e626004fa",
    "type": "playbooks",
    "attributes": {
      "title": "How to handle customer-facing incident?",
      "summary": "This is a summary",
      "external_url": null,
      "severity_ids": [],
      "environment_ids": [
        "052468f9-4bc0-4be8-9b74-a918077edc3e",
        "25bf8591-0bc9-444f-9eeb-75aee09655db"
      ],
      "service_ids": [
        "31d67ad6-32f5-41af-b8fd-6ff4fec64030",
        "d17dbf65-2fa2-4c1a-ad96-c1ed1bc60f95"
      ],
      "functionality_ids": [
        "fcc6a2b2-5b5e-40c7-a7aa-78aa3d3d416b",
        "236c70af-711f-49c8-b7dd-e023fa9eba17"
      ],
      "group_ids": [],
      "incident_type_ids": [],
      "cause_ids": [],
      "created_at": "2025-12-02T16:16:41.962-08:00",
      "updated_at": "2025-12-02T16:16:41.962-08:00"
    },
    "relationships": {
      "severities": {
        "data": []
      },
      "environments": {
        "data": [
          {
            "id": "052468f9-4bc0-4be8-9b74-a918077edc3e",
            "type": "environments"
          },
          {
            "id": "25bf8591-0bc9-444f-9eeb-75aee09655db",
            "type": "environments"
          }
        ]
      },
      "services": {
        "data": [
          {
            "id": "31d67ad6-32f5-41af-b8fd-6ff4fec64030",
            "type": "services"
          },
          {
            "id": "d17dbf65-2fa2-4c1a-ad96-c1ed1bc60f95",
            "type": "services"
          }
        ]
      },
      "functionalities": {
        "data": [
          {
            "id": "fcc6a2b2-5b5e-40c7-a7aa-78aa3d3d416b",
            "type": "functionalities"
          },
          {
            "id": "236c70af-711f-49c8-b7dd-e023fa9eba17",
            "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