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": "133bc42c-b951-4bcf-ba1a-8281077a7bce",
    "type": "playbooks",
    "attributes": {
      "title": "How to handle customer-facing incident?",
      "summary": "This is a summary",
      "external_url": null,
      "severity_ids": [],
      "environment_ids": [
        "6b69930d-52c4-466d-976b-bf11e8537ed5",
        "97c9bd57-12d2-4125-8951-c2b57fff01e4"
      ],
      "service_ids": [
        "aa252bb1-dc6b-47cb-81e4-f00c0bd35016",
        "dd45795f-2d91-416c-a26b-7eb0357b9639"
      ],
      "functionality_ids": [
        "2d534b3e-91b3-4a64-bf70-028883d696e6",
        "eed5d567-0ec5-45dc-b6f9-0f628dc6e55a"
      ],
      "group_ids": [],
      "incident_type_ids": [],
      "cause_ids": [],
      "created_at": "2025-12-01T14:21:07.070-08:00",
      "updated_at": "2025-12-01T14:21:07.070-08:00"
    },
    "relationships": {
      "severities": {
        "data": []
      },
      "environments": {
        "data": [
          {
            "id": "6b69930d-52c4-466d-976b-bf11e8537ed5",
            "type": "environments"
          },
          {
            "id": "97c9bd57-12d2-4125-8951-c2b57fff01e4",
            "type": "environments"
          }
        ]
      },
      "services": {
        "data": [
          {
            "id": "aa252bb1-dc6b-47cb-81e4-f00c0bd35016",
            "type": "services"
          },
          {
            "id": "dd45795f-2d91-416c-a26b-7eb0357b9639",
            "type": "services"
          }
        ]
      },
      "functionalities": {
        "data": [
          {
            "id": "2d534b3e-91b3-4a64-bf70-028883d696e6",
            "type": "functionalities"
          },
          {
            "id": "eed5d567-0ec5-45dc-b6f9-0f628dc6e55a",
            "type": "functionalities"
          }
        ]
      },
      "groups": {
        "data": []
      },
      "causes": {
        "data": []
      },
      "incident_types": {
        "data": []
      }
    }
  }
}

Authorizations

Authorization
string
header
required

Body

application/vnd.api+json
data
object
required

Response

data
object
required