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": "a0d34a44-77bd-4764-b35a-4f5483bf217c",
    "type": "playbooks",
    "attributes": {
      "title": "How to handle customer-facing incident?",
      "summary": "This is a summary",
      "external_url": null,
      "severity_ids": [],
      "environment_ids": [
        "21c6c03b-3635-4fca-8455-001465dccc0d",
        "ec33db8f-c688-41b0-8712-0a979b88f469"
      ],
      "service_ids": [
        "04a73611-058c-4eeb-af52-ca9c7a0b493f",
        "8d2a1c89-555b-454a-b966-0577321edbe6"
      ],
      "functionality_ids": [
        "ea236fb0-86f0-418c-8060-9aaead2a4430",
        "d3a3e2d2-6539-4804-94e3-03eba825c1ea"
      ],
      "group_ids": [],
      "incident_type_ids": [],
      "cause_ids": [],
      "created_at": "2026-02-01T18:06:16.262-08:00",
      "updated_at": "2026-02-01T18:06:16.262-08:00"
    },
    "relationships": {
      "severities": {
        "data": []
      },
      "environments": {
        "data": [
          {
            "id": "21c6c03b-3635-4fca-8455-001465dccc0d",
            "type": "environments"
          },
          {
            "id": "ec33db8f-c688-41b0-8712-0a979b88f469",
            "type": "environments"
          }
        ]
      },
      "services": {
        "data": [
          {
            "id": "04a73611-058c-4eeb-af52-ca9c7a0b493f",
            "type": "services"
          },
          {
            "id": "8d2a1c89-555b-454a-b966-0577321edbe6",
            "type": "services"
          }
        ]
      },
      "functionalities": {
        "data": [
          {
            "id": "ea236fb0-86f0-418c-8060-9aaead2a4430",
            "type": "functionalities"
          },
          {
            "id": "d3a3e2d2-6539-4804-94e3-03eba825c1ea",
            "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