PlaybookRuns

Create a new playbook run

Create a new playbook run in a team, using a playbook as template, with a specific name and a specific owner.

post/plugins/playbooks/api/v0/runs

Request body

namestring required

The name of the playbook run.

summarystring

The summary of the playbook run.

owner_user_idstring required

The identifier of the user who is commanding the playbook run.

team_idstring required

The identifier of the team where the playbook run's channel is in.

post_idstring

If the playbook run was created from a post, this field contains the identifier of such post. If not, this field is empty.

playbook_idstring required

The identifier of the playbook with from which this playbook run was created.

Example request

{
  "name": "Server down in EU cluster",
  "summary": "There is one server in the EU cluster that is not responding since April 12.",
  "owner_user_id": "bqnbdf8uc0a8yz4i39qrpgkvtg",
  "team_id": "61ji2mpflefup3cnuif80r5rde",
  "post_id": "b2ntfcrl4ujivl456ab4b3aago",
  "playbook_id": "0y4a0ntte97cxvfont8y84wa7x"
}

Response

Created playbook run.

idstring

A unique, 26 characters long, alphanumeric identifier for the playbook run.

namestring

The name of the playbook run.

summarystring

The summary of the playbook run.

is_activeboolean

True if the playbook run is ongoing; false if the playbook run is ended.

owner_user_idstring

The identifier of the user that is commanding the playbook run.

team_idstring

The identifier of the team where the playbook run's channel is in.

channel_idstring

The identifier of the playbook run's channel.

create_atinteger

The playbook run creation timestamp, formatted as the number of milliseconds since the Unix epoch.

end_atinteger

The playbook run finish timestamp, formatted as the number of milliseconds since the Unix epoch. It equals 0 if the playbook run is not finished.

delete_atinteger

The playbook run deletion timestamp, formatted as the number of milliseconds since the Unix epoch. It equals 0 if the playbook run is not deleted.

active_stageinteger

Zero-based index of the currently active stage.

active_stage_titlestring

The title of the currently active stage.

post_idstring

If the playbook run was created from a post, this field contains the identifier of such post. If not, this field is empty.

playbook_idstring

The identifier of the playbook with from which this playbook run was created.

Example response

{
  "id": "mx3xyzdojfgyfdx8sc8of1gdme",
  "name": "Server down in EU cluster",
  "summary": "There is one server in the EU cluster that is not responding since April 12.",
  "owner_user_id": "bqnbdf8uc0a8yz4i39qrpgkvtg",
  "team_id": "61ji2mpflefup3cnuif80r5rde",
  "channel_id": "hwrmiyzj3kadcilh3ukfcnsbt6",
  "create_at": 1606807976289,
  "active_stage": 1,
  "active_stage_title": "Triage issue",
  "post_id": "b2ntfcrl4ujivl456ab4b3aago",
  "playbook_id": "0y4a0ntte97cxvfont8y84wa7x",
  "checklists": [
    {
      "id": "6f6nsgxzoq84fqh1dnlyivgafd",
      "title": "Triage issue",
      "items": [
        {
          "id": "6f6nsgxzoq84fqh1dnlyivgafd",
          "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/).",
          "delete_at": 1607774621321,
          "due_date": 1607774621321,
          "requirements": [
            {
              "id": "req1abcxyz",
              "label": "Ticket URL",
              "value": "https://jira.example.com/browse/ABC-123"
            }
          ],
          "update_at": 1607774621321,
          "condition_id": "6f6nsgxzoq84fqh1dnlyivgafd",
          "condition_action": "hidden",
          "condition_reason": "Severity is Critical AND Status is not Closed"
        }
      ]
    }
  ]
}

Changes

Changed in 4 of the 47 revisions of this API.211

Aug 25, 20262acd884508c41See the full diff
- ○
  added the optional property checklists/items/items/items/requirements to the response with the 201 status
  response-optional-property-added
Jan 22, 20267cc35d281cdf22See the full diff
- ●
  removed the request property description
  request-property-removed
- ●
  removed the optional property description from the response with the 201 status
  response-optional-property-removed
- ○
  added the new optional request property summary
  new-optional-request-property
- ○
  added the optional property summary to the response with the 201 status
  response-optional-property-added
Oct 13, 20253b1944780f927See the full diff
- ○
  added the optional property checklists/items/items/items/condition_action to the response with the 201 status
  response-optional-property-added
- ○
  added the optional property checklists/items/items/items/condition_id to the response with the 201 status
  response-optional-property-added
- ○
  added the optional property checklists/items/items/items/condition_reason to the response with the 201 status
  response-optional-property-added
- ○
  added the optional property checklists/items/items/items/delete_at to the response with the 201 status
  response-optional-property-added
- ○
  added the optional property checklists/items/items/items/due_date to the response with the 201 status
  response-optional-property-added
- ○
  added the optional property checklists/items/items/items/task_actions to the response with the 201 status
  response-optional-property-added
- ○
  added the optional property checklists/items/items/items/update_at to the response with the 201 status
  response-optional-property-added
Jun 19, 2023148981c0ea861See the full diff
- ○
  endpoint added
  endpoint-added

Full history