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": "f895204a-1ecc-417a-9ddb-a0bda8442b86",
    "type": "playbooks",
    "attributes": {
      "title": "How to handle customer-facing incident?",
      "summary": "This is a summary",
      "external_url": null,
      "severity_ids": [],
      "environment_ids": [
        "6626f327-2b93-4c49-87b6-809a38df35e3",
        "08986d12-0190-4b92-94ef-b8a097563210"
      ],
      "service_ids": [
        "8e5b0fb7-cb65-4367-a1d9-70ac093538ba",
        "82a5e333-9142-4425-b78d-31c0c98e20cb"
      ],
      "functionality_ids": [
        "97aeab83-1ee7-44d4-b2f6-2324fcf7d949",
        "472bcad2-ce8b-4e21-95c5-a0d1ea1f618f"
      ],
      "group_ids": [],
      "incident_type_ids": [],
      "cause_ids": [],
      "created_at": "2025-09-18T09:21:06.272-07:00",
      "updated_at": "2025-09-18T09:21:06.272-07:00"
    },
    "relationships": {
      "severities": {
        "data": []
      },
      "environments": {
        "data": [
          {
            "id": "6626f327-2b93-4c49-87b6-809a38df35e3",
            "type": "environments"
          },
          {
            "id": "08986d12-0190-4b92-94ef-b8a097563210",
            "type": "environments"
          }
        ]
      },
      "services": {
        "data": [
          {
            "id": "8e5b0fb7-cb65-4367-a1d9-70ac093538ba",
            "type": "services"
          },
          {
            "id": "82a5e333-9142-4425-b78d-31c0c98e20cb",
            "type": "services"
          }
        ]
      },
      "functionalities": {
        "data": [
          {
            "id": "97aeab83-1ee7-44d4-b2f6-2324fcf7d949",
            "type": "functionalities"
          },
          {
            "id": "472bcad2-ce8b-4e21-95c5-a0d1ea1f618f",
            "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