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": "4825ee11-6756-4b72-8b7f-dd2dc33f95e2",
    "type": "playbooks",
    "attributes": {
      "title": "How to handle customer-facing incident?",
      "summary": "This is a summary",
      "external_url": null,
      "severity_ids": [],
      "environment_ids": [
        "64e86bd3-f3e3-4481-8c66-ac5a83dde02a",
        "b45bd071-3b3b-4a70-87e2-4d2066ad5d66"
      ],
      "service_ids": [
        "27d668ae-7a63-4874-a17c-f984d0f15a7a",
        "a8a6b2e2-8468-40de-8e14-b0d31f119f76"
      ],
      "functionality_ids": [
        "9a0d2e74-7025-423f-a3d3-8e3c958153b8",
        "e228bb0a-2962-4f8c-bde2-34004831a1b0"
      ],
      "group_ids": [],
      "incident_type_ids": [],
      "cause_ids": [],
      "created_at": "2026-01-22T16:21:11.973-08:00",
      "updated_at": "2026-01-22T16:21:11.973-08:00"
    },
    "relationships": {
      "severities": {
        "data": []
      },
      "environments": {
        "data": [
          {
            "id": "64e86bd3-f3e3-4481-8c66-ac5a83dde02a",
            "type": "environments"
          },
          {
            "id": "b45bd071-3b3b-4a70-87e2-4d2066ad5d66",
            "type": "environments"
          }
        ]
      },
      "services": {
        "data": [
          {
            "id": "27d668ae-7a63-4874-a17c-f984d0f15a7a",
            "type": "services"
          },
          {
            "id": "a8a6b2e2-8468-40de-8e14-b0d31f119f76",
            "type": "services"
          }
        ]
      },
      "functionalities": {
        "data": [
          {
            "id": "9a0d2e74-7025-423f-a3d3-8e3c958153b8",
            "type": "functionalities"
          },
          {
            "id": "e228bb0a-2962-4f8c-bde2-34004831a1b0",
            "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