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": "f4788a16-d00e-4811-8897-0afe4fda3adf",
    "type": "playbooks",
    "attributes": {
      "title": "How to handle customer-facing incident?",
      "summary": "This is a summary",
      "external_url": null,
      "severity_ids": [],
      "environment_ids": [
        "ce80c4d8-7e9a-4ebd-99c7-059e58634d0a",
        "0a0b6f5a-873a-43ad-b7fb-b62bb1af4f39"
      ],
      "service_ids": [
        "62b5f5e2-18be-4966-a4b1-02396b8b8aa5",
        "356f7a7b-01d0-45ff-974d-c50e24aebca5"
      ],
      "functionality_ids": [
        "72ed5dc0-6c3d-4103-92cd-acfedd4eb077",
        "24f2dba8-eb4e-4878-98c6-ffbf59e8f408"
      ],
      "group_ids": [],
      "incident_type_ids": [],
      "cause_ids": [],
      "created_at": "2025-07-09T00:17:19.048-07:00",
      "updated_at": "2025-07-09T00:17:19.048-07:00"
    },
    "relationships": {
      "severities": {
        "data": []
      },
      "environments": {
        "data": [
          {
            "id": "ce80c4d8-7e9a-4ebd-99c7-059e58634d0a",
            "type": "environments"
          },
          {
            "id": "0a0b6f5a-873a-43ad-b7fb-b62bb1af4f39",
            "type": "environments"
          }
        ]
      },
      "services": {
        "data": [
          {
            "id": "62b5f5e2-18be-4966-a4b1-02396b8b8aa5",
            "type": "services"
          },
          {
            "id": "356f7a7b-01d0-45ff-974d-c50e24aebca5",
            "type": "services"
          }
        ]
      },
      "functionalities": {
        "data": [
          {
            "id": "72ed5dc0-6c3d-4103-92cd-acfedd4eb077",
            "type": "functionalities"
          },
          {
            "id": "24f2dba8-eb4e-4878-98c6-ffbf59e8f408",
            "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.