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": "93635557-d000-4712-be32-7574b5090ce5",
    "type": "playbooks",
    "attributes": {
      "title": "How to handle customer-facing incident?",
      "summary": "This is a summary",
      "external_url": null,
      "severity_ids": [],
      "environment_ids": [
        "789ee2c0-f4a4-4ff2-a848-cd9e3c0870ca",
        "71b89817-e1e3-4e2f-9cab-ed7af0a760f5"
      ],
      "service_ids": [
        "01cdf496-22bb-4d13-a974-9ac9ea4996b9",
        "7d827d56-5c9b-4d45-b4b3-42b4356c3402"
      ],
      "functionality_ids": [
        "2b1fc098-cb0f-445a-b9ee-d9fa5c84ac0b",
        "3533cf40-519b-40d0-b720-1bc65e947962"
      ],
      "group_ids": [],
      "incident_type_ids": [],
      "cause_ids": [],
      "created_at": "2025-12-19T18:17:40.804-08:00",
      "updated_at": "2025-12-19T18:17:40.804-08:00"
    },
    "relationships": {
      "severities": {
        "data": []
      },
      "environments": {
        "data": [
          {
            "id": "789ee2c0-f4a4-4ff2-a848-cd9e3c0870ca",
            "type": "environments"
          },
          {
            "id": "71b89817-e1e3-4e2f-9cab-ed7af0a760f5",
            "type": "environments"
          }
        ]
      },
      "services": {
        "data": [
          {
            "id": "01cdf496-22bb-4d13-a974-9ac9ea4996b9",
            "type": "services"
          },
          {
            "id": "7d827d56-5c9b-4d45-b4b3-42b4356c3402",
            "type": "services"
          }
        ]
      },
      "functionalities": {
        "data": [
          {
            "id": "2b1fc098-cb0f-445a-b9ee-d9fa5c84ac0b",
            "type": "functionalities"
          },
          {
            "id": "3533cf40-519b-40d0-b720-1bc65e947962",
            "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