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": "a0dd0aae-9ed8-4c8a-8ea4-d6930e84e5b0",
    "type": "playbooks",
    "attributes": {
      "title": "How to handle customer-facing incident?",
      "summary": "This is a summary",
      "external_url": null,
      "severity_ids": [],
      "environment_ids": [
        "1eb9cd54-2c07-4882-8ece-6da721b1021f",
        "48ec6028-f749-401f-92a5-149d2bfe2f9a"
      ],
      "service_ids": [
        "7321788d-3245-4d67-8a8e-e121584b594f",
        "71ecf6e7-f884-4567-8829-5838183f5be3"
      ],
      "functionality_ids": [
        "ef8fb207-0baa-4184-b0ee-e285016e04bb",
        "8e95084c-a303-4cd5-91e9-4bae52cfffec"
      ],
      "group_ids": [],
      "incident_type_ids": [],
      "cause_ids": [],
      "created_at": "2025-06-19T02:42:52.284-07:00",
      "updated_at": "2025-06-19T02:42:52.284-07:00"
    },
    "relationships": {
      "severities": {
        "data": []
      },
      "environments": {
        "data": [
          {
            "id": "1eb9cd54-2c07-4882-8ece-6da721b1021f",
            "type": "environments"
          },
          {
            "id": "48ec6028-f749-401f-92a5-149d2bfe2f9a",
            "type": "environments"
          }
        ]
      },
      "services": {
        "data": [
          {
            "id": "7321788d-3245-4d67-8a8e-e121584b594f",
            "type": "services"
          },
          {
            "id": "71ecf6e7-f884-4567-8829-5838183f5be3",
            "type": "services"
          }
        ]
      },
      "functionalities": {
        "data": [
          {
            "id": "ef8fb207-0baa-4184-b0ee-e285016e04bb",
            "type": "functionalities"
          },
          {
            "id": "8e95084c-a303-4cd5-91e9-4bae52cfffec",
            "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.