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": "e2949f5b-de67-4bbb-bdfd-bfd2950fd1b9",
    "type": "playbooks",
    "attributes": {
      "title": "How to handle customer-facing incident?",
      "summary": "This is a summary",
      "external_url": null,
      "severity_ids": [],
      "environment_ids": [
        "9b198a0c-0ec9-4116-887c-ac593ab2032c",
        "ef80eced-3847-4348-9997-f8be0cd16a7d"
      ],
      "service_ids": [
        "03b05aaf-941f-4c77-98ce-e8ce375fbd76",
        "b8cca034-3049-475d-afd7-a2174fe43a6b"
      ],
      "functionality_ids": [
        "081dc7a0-e67f-4e06-b303-76d1909fbdd4",
        "8799fd44-63f0-4618-8af2-a29fd3f4f862"
      ],
      "group_ids": [],
      "incident_type_ids": [],
      "cause_ids": [],
      "created_at": "2026-01-29T18:47:17.434-08:00",
      "updated_at": "2026-01-29T18:47:17.434-08:00"
    },
    "relationships": {
      "severities": {
        "data": []
      },
      "environments": {
        "data": [
          {
            "id": "9b198a0c-0ec9-4116-887c-ac593ab2032c",
            "type": "environments"
          },
          {
            "id": "ef80eced-3847-4348-9997-f8be0cd16a7d",
            "type": "environments"
          }
        ]
      },
      "services": {
        "data": [
          {
            "id": "03b05aaf-941f-4c77-98ce-e8ce375fbd76",
            "type": "services"
          },
          {
            "id": "b8cca034-3049-475d-afd7-a2174fe43a6b",
            "type": "services"
          }
        ]
      },
      "functionalities": {
        "data": [
          {
            "id": "081dc7a0-e67f-4e06-b303-76d1909fbdd4",
            "type": "functionalities"
          },
          {
            "id": "8799fd44-63f0-4618-8af2-a29fd3f4f862",
            "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