Sign in

v46

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

Add an item to a playbook run's checklist

The most common pattern to add a new item is to only send its title as the request payload. By default, it is an open item, with no assignee and no slash command.

post/plugins/playbooks/api/v0/runs/{id}/checklists/{checklist}/add

Path parameters

idstring required

ID of the playbook run whose checklist will be modified.

checklistinteger required

Zero-based index of the checklist to modify.

Request body

titlestring required

The title of the checklist item.

state'' | 'in_progress' | 'closed'

The state of the checklist item. An empty string means that the item is not done.

state_modifiedinteger

The timestamp for the latest modification of the item's state, formatted as the number of milliseconds since the Unix epoch. It equals 0 if the item was never modified.

assignee_idstring

The identifier of the user that has been assigned to complete this item. If the item has no assignee, this is an empty string.

assignee_modifiedinteger

The timestamp for the latest modification of the item's assignee, formatted as the number of milliseconds since the Unix epoch. It equals 0 if the item never got an assignee.

commandstring

The slash command associated with this item. If the item has no slash command associated, this is an empty string

command_last_runinteger

The timestamp for the latest execution of the item's command, formatted as the number of milliseconds since the Unix epoch. It equals 0 if the command was never executed.

descriptionstring

A detailed description of the checklist item, formatted with Markdown.

Example request

{
  "title": "Gather information from customer.",
  "state": "closed",
  "state_modified": 1607774621321,
  "assignee_id": "pisdatkjtdlkdhht2v4inxuzx1",
  "assignee_modified": 1608897821125,
  "command": "/opsgenie on-call",
  "command_last_run": 1608552221019,
  "description": "Ask the customer for more information in [Zendesk](https://www.zendesk.com/)."
}

Response

Item successfully added.