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": "e759aade-32d7-4393-8492-caead9aa9575",
    "type": "playbooks",
    "attributes": {
      "title": "How to handle customer-facing incident?",
      "summary": "This is a summary",
      "external_url": null,
      "severity_ids": [],
      "environment_ids": [
        "f63616ed-104f-4497-901c-6b5c91ab11b8",
        "e01977cc-b089-49d4-a7c3-1d76470d398a"
      ],
      "service_ids": [
        "b88beae4-308d-47f8-9545-e02b3ec6395e",
        "c12e4b48-87c1-424a-9233-d2e41df832cb"
      ],
      "functionality_ids": [
        "45ceea8d-fc8b-4a8f-a8ff-23b069a7529c",
        "c5917948-b605-4d0f-b7f3-826568054961"
      ],
      "group_ids": [],
      "incident_type_ids": [],
      "cause_ids": [],
      "created_at": "2025-11-06T13:28:28.060-08:00",
      "updated_at": "2025-11-06T13:28:28.060-08:00"
    },
    "relationships": {
      "severities": {
        "data": []
      },
      "environments": {
        "data": [
          {
            "id": "f63616ed-104f-4497-901c-6b5c91ab11b8",
            "type": "environments"
          },
          {
            "id": "e01977cc-b089-49d4-a7c3-1d76470d398a",
            "type": "environments"
          }
        ]
      },
      "services": {
        "data": [
          {
            "id": "b88beae4-308d-47f8-9545-e02b3ec6395e",
            "type": "services"
          },
          {
            "id": "c12e4b48-87c1-424a-9233-d2e41df832cb",
            "type": "services"
          }
        ]
      },
      "functionalities": {
        "data": [
          {
            "id": "45ceea8d-fc8b-4a8f-a8ff-23b069a7529c",
            "type": "functionalities"
          },
          {
            "id": "c5917948-b605-4d0f-b7f3-826568054961",
            "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