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": "bd31dda8-3f7d-4af6-afa3-1c05795ca009",
    "type": "playbooks",
    "attributes": {
      "title": "How to handle customer-facing incident?",
      "summary": "This is a summary",
      "external_url": null,
      "severity_ids": [],
      "environment_ids": [
        "5c250dba-2fef-4331-a40e-2f15fb3812fb",
        "571ea787-b54e-4829-9792-c9754641b14d"
      ],
      "service_ids": [
        "16c82e77-6e34-4879-91b7-1781f5cada01",
        "b63b4369-067e-4abc-8886-ba095d5e3f84"
      ],
      "functionality_ids": [
        "94afcdc1-caea-4d01-81e9-9ed017ba1c89",
        "b4a8124f-a6b6-42da-8cd9-45ea2c142a7e"
      ],
      "group_ids": [],
      "incident_type_ids": [],
      "cause_ids": [],
      "created_at": "2025-12-21T12:10:15.962-08:00",
      "updated_at": "2025-12-21T12:10:15.962-08:00"
    },
    "relationships": {
      "severities": {
        "data": []
      },
      "environments": {
        "data": [
          {
            "id": "5c250dba-2fef-4331-a40e-2f15fb3812fb",
            "type": "environments"
          },
          {
            "id": "571ea787-b54e-4829-9792-c9754641b14d",
            "type": "environments"
          }
        ]
      },
      "services": {
        "data": [
          {
            "id": "16c82e77-6e34-4879-91b7-1781f5cada01",
            "type": "services"
          },
          {
            "id": "b63b4369-067e-4abc-8886-ba095d5e3f84",
            "type": "services"
          }
        ]
      },
      "functionalities": {
        "data": [
          {
            "id": "94afcdc1-caea-4d01-81e9-9ed017ba1c89",
            "type": "functionalities"
          },
          {
            "id": "b4a8124f-a6b6-42da-8cd9-45ea2c142a7e",
            "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