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": "379bcd5d-ee90-49c8-80ce-d1a1be7c81c8",
    "type": "playbooks",
    "attributes": {
      "title": "How to handle customer-facing incident?",
      "summary": "This is a summary",
      "external_url": null,
      "severity_ids": [],
      "environment_ids": [
        "ee1ae8de-64e0-48a5-943b-73a5b734f064",
        "f1e03109-ebc4-475f-a244-0abc888f9401"
      ],
      "service_ids": [
        "4bd89c72-4811-4558-8528-287842060034",
        "6bf268c2-dba3-4b76-a9c6-300e05538409"
      ],
      "functionality_ids": [
        "8904dd6c-f628-4269-8783-b0c5e5a884de",
        "6955b9c5-772f-4bb2-8986-c8094ed22ca1"
      ],
      "group_ids": [],
      "incident_type_ids": [],
      "cause_ids": [],
      "created_at": "2025-12-13T18:51:38.791-08:00",
      "updated_at": "2025-12-13T18:51:38.791-08:00"
    },
    "relationships": {
      "severities": {
        "data": []
      },
      "environments": {
        "data": [
          {
            "id": "ee1ae8de-64e0-48a5-943b-73a5b734f064",
            "type": "environments"
          },
          {
            "id": "f1e03109-ebc4-475f-a244-0abc888f9401",
            "type": "environments"
          }
        ]
      },
      "services": {
        "data": [
          {
            "id": "4bd89c72-4811-4558-8528-287842060034",
            "type": "services"
          },
          {
            "id": "6bf268c2-dba3-4b76-a9c6-300e05538409",
            "type": "services"
          }
        ]
      },
      "functionalities": {
        "data": [
          {
            "id": "8904dd6c-f628-4269-8783-b0c5e5a884de",
            "type": "functionalities"
          },
          {
            "id": "6955b9c5-772f-4bb2-8986-c8094ed22ca1",
            "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