Sign in

v46

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-174421106.5 KB
Playbooks

Create a playbook

post/plugins/playbooks/api/v0/playbooks

Request body

titlestring required

The title of the playbook.

descriptionstring

The description of the playbook.

team_idstring required

The identifier of the team where the playbook is in.

create_public_playbook_runboolean required

A boolean indicating whether the playbook runs created from this playbook should be public or private.

publicboolean

A boolean indicating whether the playbook is licensed as public or private. Required 'true' for free tier.

member_idsstring[] required

The identifiers of all the users that are members of this playbook.

broadcast_channel_idsstring[]

The IDs of the channels where all the status updates will be broadcasted. The team of the broadcast channel must be the same as the playbook's team.

invited_user_idsstring[]

A list with the IDs of the members to be automatically invited to the playbook run's channel as soon as the playbook run is created.

invite_users_enabledboolean

Boolean that indicates whether the members declared in invited_user_ids will be automatically invited.

default_owner_idstring

User ID of the member that will be automatically assigned as owner as soon as the playbook run is created. If the member is not part of the playbook run's channel or is not included in the invited_user_ids list, they will be automatically invited to the channel.

default_owner_enabledstring

Boolean that indicates whether the member declared in default_owner_id will be automatically assigned as owner.

announcement_channel_idstring

ID of the channel where the playbook run will be automatically announced as soon as the playbook run is created.

announcement_channel_enabledboolean

Boolean that indicates whether the playbook run creation will be announced in the channel declared in announcement_channel_id.

webhook_on_creation_urlstring

An absolute URL where a POST request will be sent as soon as the playbook run is created. The allowed protocols are HTTP and HTTPS.

webhook_on_creation_enabledboolean

Boolean that indicates whether the webhook declared in webhook_on_creation_url will be automatically sent.

webhook_on_status_update_urlstring

An absolute URL where a POST request will be sent as soon as the playbook run's status is updated. The allowed protocols are HTTP and HTTPS.

webhook_on_status_update_enabledboolean

Boolean that indicates whether the webhook declared in webhook_on_status_update_url will be automatically sent.

Example request

{
  "title": "Cloud PlaybookRuns",
  "description": "A playbook to follow when there is a playbook run regarding the availability of the cloud service.",
  "team_id": "p03rbi6viyztysbqnkvcqyel2i",
  "create_public_playbook_run": true,
  "public": true,
  "checklists": [
    {
      "title": "Triage issue",
      "items": [
        {
          "title": "Gather information from customer.",
          "command": "/opsgenie on-call",
          "description": "Ask the customer for more information in [Zendesk](https://www.zendesk.com/)."
        }
      ]
    }
  ],
  "member_ids": [
    "ilh6s1j4yefbdhxhtlzt179i6m"
  ],
  "broadcast_channel_ids": [
    "2zh7rpashwfwapwaqyslmhwbax"
  ],
  "invited_user_ids": [
    "01kidjn9iozv7bist427w4gkjo"
  ],
  "invite_users_enabled": true,
  "default_owner_id": "9dtruav6d9ce3oqnc5pwhtqtfq",
  "announcement_channel_id": "8iofau5swv32l6qtk3vlxgobta",
  "announcement_channel_enabled": true,
  "webhook_on_creation_url": "https://httpbin.org/post",
  "webhook_on_creation_enabled": true,
  "webhook_on_status_update_url": "https://httpbin.org/post",
  "webhook_on_status_update_enabled": true
}

Response

ID of the created playbook.

idstring required

Example response

{
  "id": "iz0g457ikesz55dhxcfa0fk9yy"
}