External DocumentationTo learn more, visit the Mattermost documentation.
Basic Parameters
| Parameter | Description |
|---|---|
| Channel ID | The ID of the channel that the returned runs must be associated with. |
| Direction | The sort direction for the returned runs. |
| Page | The page number to retrieve, starting at 0. |
| Per Page | The maximum number of items to retrieve per page. |
| Return All Pages | Automatically fetch all resources, page by page. |
| Search Term | The search term to filter the playbook name by. |
| Sort | The field to sort the returned runs by. |
| Statuses | The status to filter the returned runs by. |
| Team ID | The ID of the team. Can be obtained from the List All Teams action. |
Advanced Parameters
| Parameter | Description |
|---|---|
| Omit Ended | Select to return only active runs. |
| Owner User ID | The ID of the user to filter runs by owner. Use me to filter by the authenticated user. Can be obtained using the List Users action. |
| Participant ID | The ID of a user that must be a participant in the returned runs. Use me to filter by the authenticated user. |
| Since | The date and time of the created or modified to filter the playbook runs since. |
Example Output
{
"total_count": 305,
"page_count": 2,
"has_more": true,
"items": [
{
"id": "mx3xyzdojfgyfdx8sc8of1gdme",
"name": "Server down in EU cluster",
"summary": "There is one server in the EU cluster that is not responding since April 12.",
"is_active": true,
"owner_user_id": "bqnbdf8uc0a8yz4i39qrpgkvtg",
"team_id": "61ji2mpflefup3cnuif80r5rde",
"channel_id": "hwrmiyzj3kadcilh3ukfcnsbt6",
"create_at": 1606807976289,
"end_at": 0,
"delete_at": 0,
"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,
"task_actions": [
{
"trigger": {},
"actions": [
{}
]
}
],
"update_at": 1607774621321,
"condition_id": "6f6nsgxzoq84fqh1dnlyivgafd",
"condition_action": "hidden",
"condition_reason": "Severity is Critical AND Status is not Closed"
}
]
}
]
}
]
}
Workflow Library Example
List Playbook Runs with Mattermost and Send Results Via Email