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": "b27c10f6-eb4f-49bd-99a8-0f6bbe3a209b",
    "type": "playbooks",
    "attributes": {
      "title": "How to handle customer-facing incident?",
      "summary": "This is a summary",
      "external_url": null,
      "severity_ids": [],
      "environment_ids": [
        "ce2a0915-8111-4a29-8330-59eb0e35f451",
        "1616fe90-d17b-413b-861a-94b5dac55657"
      ],
      "service_ids": [
        "fa3b3a12-87e4-4e0e-96d3-6a263c24aa16",
        "98a5efb6-eb9d-47ba-8901-183bbb347c86"
      ],
      "functionality_ids": [
        "0c5e8a47-5fbf-497f-9881-fabd27c4e109",
        "93b04db9-4c2e-475b-9ed9-d54d33b31081"
      ],
      "group_ids": [],
      "incident_type_ids": [],
      "cause_ids": [],
      "created_at": "2026-02-04T06:13:13.109-08:00",
      "updated_at": "2026-02-04T06:13:13.109-08:00"
    },
    "relationships": {
      "severities": {
        "data": []
      },
      "environments": {
        "data": [
          {
            "id": "ce2a0915-8111-4a29-8330-59eb0e35f451",
            "type": "environments"
          },
          {
            "id": "1616fe90-d17b-413b-861a-94b5dac55657",
            "type": "environments"
          }
        ]
      },
      "services": {
        "data": [
          {
            "id": "fa3b3a12-87e4-4e0e-96d3-6a263c24aa16",
            "type": "services"
          },
          {
            "id": "98a5efb6-eb9d-47ba-8901-183bbb347c86",
            "type": "services"
          }
        ]
      },
      "functionalities": {
        "data": [
          {
            "id": "0c5e8a47-5fbf-497f-9881-fabd27c4e109",
            "type": "functionalities"
          },
          {
            "id": "93b04db9-4c2e-475b-9ed9-d54d33b31081",
            "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