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": "82734995-5a27-42a4-a1f4-3345005f61f6",
    "type": "playbooks",
    "attributes": {
      "title": "How to handle customer-facing incident?",
      "summary": "This is a summary",
      "external_url": null,
      "severity_ids": [],
      "environment_ids": [
        "2912fc4f-f217-4ce8-bdb4-570d1bd766bf",
        "f082566d-56ed-4c1f-8ea8-60a54b31a78c"
      ],
      "service_ids": [
        "ccb102b2-13e6-4b24-932a-1fa04a2da2dd",
        "7a991866-091e-4b4f-990d-6453261920b2"
      ],
      "functionality_ids": [
        "f11220a6-1255-4961-969e-f9672e216894",
        "3a931360-5aa4-4934-8104-e058d72afa3a"
      ],
      "group_ids": [],
      "incident_type_ids": [],
      "cause_ids": [],
      "created_at": "2026-01-08T16:27:37.351-08:00",
      "updated_at": "2026-01-08T16:27:37.351-08:00"
    },
    "relationships": {
      "severities": {
        "data": []
      },
      "environments": {
        "data": [
          {
            "id": "2912fc4f-f217-4ce8-bdb4-570d1bd766bf",
            "type": "environments"
          },
          {
            "id": "f082566d-56ed-4c1f-8ea8-60a54b31a78c",
            "type": "environments"
          }
        ]
      },
      "services": {
        "data": [
          {
            "id": "ccb102b2-13e6-4b24-932a-1fa04a2da2dd",
            "type": "services"
          },
          {
            "id": "7a991866-091e-4b4f-990d-6453261920b2",
            "type": "services"
          }
        ]
      },
      "functionalities": {
        "data": [
          {
            "id": "f11220a6-1255-4961-969e-f9672e216894",
            "type": "functionalities"
          },
          {
            "id": "3a931360-5aa4-4934-8104-e058d72afa3a",
            "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