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": "212b14d3-e50f-48aa-99e3-f6694af49752",
    "type": "playbooks",
    "attributes": {
      "title": "How to handle customer-facing incident?",
      "summary": "This is a summary",
      "external_url": null,
      "severity_ids": [],
      "environment_ids": [
        "07c636df-9763-40ce-a5bd-d99d5c5c217a",
        "51cb2ffc-055e-4b1e-8755-6da964deb425"
      ],
      "service_ids": [
        "cd77649f-5c38-409b-b973-f69088ffb1c7",
        "f8cf99b6-45c8-4899-bcfc-3b303c8d1203"
      ],
      "functionality_ids": [
        "b2380905-a66f-411f-b58c-b241df80cf6d",
        "bc5eaa6d-165e-4ee3-974d-93ba477785a7"
      ],
      "group_ids": [],
      "incident_type_ids": [],
      "cause_ids": [],
      "created_at": "2026-02-06T18:27:53.972-08:00",
      "updated_at": "2026-02-06T18:27:53.972-08:00"
    },
    "relationships": {
      "severities": {
        "data": []
      },
      "environments": {
        "data": [
          {
            "id": "07c636df-9763-40ce-a5bd-d99d5c5c217a",
            "type": "environments"
          },
          {
            "id": "51cb2ffc-055e-4b1e-8755-6da964deb425",
            "type": "environments"
          }
        ]
      },
      "services": {
        "data": [
          {
            "id": "cd77649f-5c38-409b-b973-f69088ffb1c7",
            "type": "services"
          },
          {
            "id": "f8cf99b6-45c8-4899-bcfc-3b303c8d1203",
            "type": "services"
          }
        ]
      },
      "functionalities": {
        "data": [
          {
            "id": "b2380905-a66f-411f-b58c-b241df80cf6d",
            "type": "functionalities"
          },
          {
            "id": "bc5eaa6d-165e-4ee3-974d-93ba477785a7",
            "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