POST
/
v1
/
playbooks
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": "75735cfd-328a-4e34-9767-651381a426c3",
    "type": "playbooks",
    "attributes": {
      "title": "How to handle customer-facing incident?",
      "summary": "This is a summary",
      "external_url": null,
      "severity_ids": [],
      "environment_ids": [
        "fc822e6b-b80a-4727-8cf9-010e46838446",
        "41d1832f-12a9-4db8-a9d4-b62296c7e971"
      ],
      "service_ids": [
        "102ac9d3-f4d5-488f-ac7d-74c27c7a21f8",
        "2eedf5fb-caf1-44fd-9242-692db05b6bc7"
      ],
      "functionality_ids": [
        "7c32fca7-0957-4bc4-b82d-c501da9981eb",
        "803802a0-7243-4262-9294-e90e4e831019"
      ],
      "group_ids": [],
      "incident_type_ids": [],
      "cause_ids": [],
      "created_at": "2025-05-29T17:47:04.511-07:00",
      "updated_at": "2025-05-29T17:47:04.511-07:00"
    },
    "relationships": {
      "severities": {
        "data": []
      },
      "environments": {
        "data": [
          {
            "id": "fc822e6b-b80a-4727-8cf9-010e46838446",
            "type": "environments"
          },
          {
            "id": "41d1832f-12a9-4db8-a9d4-b62296c7e971",
            "type": "environments"
          }
        ]
      },
      "services": {
        "data": [
          {
            "id": "102ac9d3-f4d5-488f-ac7d-74c27c7a21f8",
            "type": "services"
          },
          {
            "id": "2eedf5fb-caf1-44fd-9242-692db05b6bc7",
            "type": "services"
          }
        ]
      },
      "functionalities": {
        "data": [
          {
            "id": "7c32fca7-0957-4bc4-b82d-c501da9981eb",
            "type": "functionalities"
          },
          {
            "id": "803802a0-7243-4262-9294-e90e4e831019",
            "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

Response

201
application/vnd.api+json

playbook created

The response is of type object.