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": "d10d4352-81ad-4543-ad6f-fad6ce563a6b",
    "type": "playbooks",
    "attributes": {
      "title": "How to handle customer-facing incident?",
      "summary": "This is a summary",
      "external_url": null,
      "severity_ids": [],
      "environment_ids": [
        "10850974-0087-40b5-b440-f967c5462f40",
        "d933be74-87c6-432c-87bd-a2d37237f115"
      ],
      "service_ids": [
        "29e2fd85-039d-4deb-bdc5-4ab8bcc7bd44",
        "1a35dd09-d76f-4de0-96d3-31dfbbdb3aa5"
      ],
      "functionality_ids": [
        "03bcc8f9-2afe-4076-b39e-a3250f11605c",
        "a2e488df-eb3b-4588-9518-89a26bb30441"
      ],
      "group_ids": [],
      "incident_type_ids": [],
      "cause_ids": [],
      "created_at": "2025-12-05T21:27:53.534-08:00",
      "updated_at": "2025-12-05T21:27:53.534-08:00"
    },
    "relationships": {
      "severities": {
        "data": []
      },
      "environments": {
        "data": [
          {
            "id": "10850974-0087-40b5-b440-f967c5462f40",
            "type": "environments"
          },
          {
            "id": "d933be74-87c6-432c-87bd-a2d37237f115",
            "type": "environments"
          }
        ]
      },
      "services": {
        "data": [
          {
            "id": "29e2fd85-039d-4deb-bdc5-4ab8bcc7bd44",
            "type": "services"
          },
          {
            "id": "1a35dd09-d76f-4de0-96d3-31dfbbdb3aa5",
            "type": "services"
          }
        ]
      },
      "functionalities": {
        "data": [
          {
            "id": "03bcc8f9-2afe-4076-b39e-a3250f11605c",
            "type": "functionalities"
          },
          {
            "id": "a2e488df-eb3b-4588-9518-89a26bb30441",
            "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