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": "3fce9eb9-b6b3-4d55-9626-99788cad3bd5",
    "type": "playbooks",
    "attributes": {
      "title": "How to handle customer-facing incident?",
      "summary": "This is a summary",
      "external_url": null,
      "severity_ids": [],
      "environment_ids": [
        "be2bf1f5-9442-4267-be5a-f3b4fa943b7c",
        "501c7f6b-646d-49ce-a99b-6e12302d575d"
      ],
      "service_ids": [
        "20905c77-113d-4da9-8fd9-87f1bfd152a5",
        "1065498d-373c-4ed4-9d29-dee31f463b39"
      ],
      "functionality_ids": [
        "ba18da33-0f88-4f5b-92f0-28f639d084da",
        "b4abc8dd-2951-43e6-bbdb-4da295519180"
      ],
      "group_ids": [],
      "incident_type_ids": [],
      "cause_ids": [],
      "created_at": "2025-09-08T13:48:48.614-07:00",
      "updated_at": "2025-09-08T13:48:48.614-07:00"
    },
    "relationships": {
      "severities": {
        "data": []
      },
      "environments": {
        "data": [
          {
            "id": "be2bf1f5-9442-4267-be5a-f3b4fa943b7c",
            "type": "environments"
          },
          {
            "id": "501c7f6b-646d-49ce-a99b-6e12302d575d",
            "type": "environments"
          }
        ]
      },
      "services": {
        "data": [
          {
            "id": "20905c77-113d-4da9-8fd9-87f1bfd152a5",
            "type": "services"
          },
          {
            "id": "1065498d-373c-4ed4-9d29-dee31f463b39",
            "type": "services"
          }
        ]
      },
      "functionalities": {
        "data": [
          {
            "id": "ba18da33-0f88-4f5b-92f0-28f639d084da",
            "type": "functionalities"
          },
          {
            "id": "b4abc8dd-2951-43e6-bbdb-4da295519180",
            "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.