POST
/
v1
/
playbooks
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": "ccf57eac-1e57-4b4e-b48a-221d053009e2",
    "type": "playbooks",
    "attributes": {
      "title": "How to handle customer-facing incident?",
      "summary": "This is a summary",
      "external_url": null,
      "severity_ids": [],
      "environment_ids": [
        "a00cbe90-2913-467e-bdb9-3c62ce688f2b",
        "a4a39956-546c-40df-8ddc-e2fcd69430d5"
      ],
      "service_ids": [
        "2fa1119f-bd3e-4e86-8040-2e2f208f364c",
        "9684631c-8e0a-41b0-a6bd-8d552ce82f57"
      ],
      "functionality_ids": [
        "f35df485-63fa-44a1-8e50-3f36c16499fb",
        "6a6c6e37-f058-44a7-a60c-05fd05fe0c25"
      ],
      "group_ids": [],
      "incident_type_ids": [],
      "cause_ids": [],
      "created_at": "2025-06-20T12:02:40.268-07:00",
      "updated_at": "2025-06-20T12:02:40.268-07:00"
    },
    "relationships": {
      "severities": {
        "data": []
      },
      "environments": {
        "data": [
          {
            "id": "a00cbe90-2913-467e-bdb9-3c62ce688f2b",
            "type": "environments"
          },
          {
            "id": "a4a39956-546c-40df-8ddc-e2fcd69430d5",
            "type": "environments"
          }
        ]
      },
      "services": {
        "data": [
          {
            "id": "2fa1119f-bd3e-4e86-8040-2e2f208f364c",
            "type": "services"
          },
          {
            "id": "9684631c-8e0a-41b0-a6bd-8d552ce82f57",
            "type": "services"
          }
        ]
      },
      "functionalities": {
        "data": [
          {
            "id": "f35df485-63fa-44a1-8e50-3f36c16499fb",
            "type": "functionalities"
          },
          {
            "id": "6a6c6e37-f058-44a7-a60c-05fd05fe0c25",
            "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

Response

201
application/vnd.api+json

playbook created

The response is of type object.