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": "e68b3634-f5ba-49ce-ae8f-7ba8478439a7",
    "type": "playbooks",
    "attributes": {
      "title": "How to handle customer-facing incident?",
      "summary": "This is a summary",
      "external_url": null,
      "severity_ids": [],
      "environment_ids": [
        "636bb995-0945-4e14-a264-5bed0d236cd8",
        "e5fd7025-91dc-4db4-aa7e-58cd4420cc3a"
      ],
      "service_ids": [
        "a24c04c3-25dc-45a0-baca-4c95a001b8d0",
        "0a4c2a5e-ad23-4f3d-87ea-5fd62e6afb54"
      ],
      "functionality_ids": [
        "45e912ab-c701-4d7b-91b3-9469d9045bef",
        "0a86e753-83c7-4fec-9b02-76a9dca97df1"
      ],
      "group_ids": [],
      "incident_type_ids": [],
      "cause_ids": [],
      "created_at": "2025-12-09T17:48:20.004-08:00",
      "updated_at": "2025-12-09T17:48:20.004-08:00"
    },
    "relationships": {
      "severities": {
        "data": []
      },
      "environments": {
        "data": [
          {
            "id": "636bb995-0945-4e14-a264-5bed0d236cd8",
            "type": "environments"
          },
          {
            "id": "e5fd7025-91dc-4db4-aa7e-58cd4420cc3a",
            "type": "environments"
          }
        ]
      },
      "services": {
        "data": [
          {
            "id": "a24c04c3-25dc-45a0-baca-4c95a001b8d0",
            "type": "services"
          },
          {
            "id": "0a4c2a5e-ad23-4f3d-87ea-5fd62e6afb54",
            "type": "services"
          }
        ]
      },
      "functionalities": {
        "data": [
          {
            "id": "45e912ab-c701-4d7b-91b3-9469d9045bef",
            "type": "functionalities"
          },
          {
            "id": "0a86e753-83c7-4fec-9b02-76a9dca97df1",
            "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