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": "b16b2b33-32ba-4b57-82a7-ee760d205073",
    "type": "playbooks",
    "attributes": {
      "title": "How to handle customer-facing incident?",
      "summary": "This is a summary",
      "external_url": null,
      "severity_ids": [],
      "environment_ids": [
        "eb23af29-fbcc-4564-9e69-7ac57428094c",
        "737b43ad-1e41-4efe-938b-daa55a2cef98"
      ],
      "service_ids": [
        "e38708e8-ba72-4e49-8a35-37d859da3339",
        "87e6f647-a42f-4890-99d4-159ec6cb35d6"
      ],
      "functionality_ids": [
        "6a9130b8-ac7b-4388-abd0-1a278f2087a6",
        "7ed529e2-11c6-4261-94fa-ad14bcca9533"
      ],
      "group_ids": [],
      "incident_type_ids": [],
      "cause_ids": [],
      "created_at": "2025-12-05T05:27:17.687-08:00",
      "updated_at": "2025-12-05T05:27:17.687-08:00"
    },
    "relationships": {
      "severities": {
        "data": []
      },
      "environments": {
        "data": [
          {
            "id": "eb23af29-fbcc-4564-9e69-7ac57428094c",
            "type": "environments"
          },
          {
            "id": "737b43ad-1e41-4efe-938b-daa55a2cef98",
            "type": "environments"
          }
        ]
      },
      "services": {
        "data": [
          {
            "id": "e38708e8-ba72-4e49-8a35-37d859da3339",
            "type": "services"
          },
          {
            "id": "87e6f647-a42f-4890-99d4-159ec6cb35d6",
            "type": "services"
          }
        ]
      },
      "functionalities": {
        "data": [
          {
            "id": "6a9130b8-ac7b-4388-abd0-1a278f2087a6",
            "type": "functionalities"
          },
          {
            "id": "7ed529e2-11c6-4261-94fa-ad14bcca9533",
            "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