Skip to main content
Create a new playbook run. Required Permissions: Must be a member of the playbook and of the team.
External DocumentationTo learn more, visit the Mattermost documentation.

Parameters

ParameterDescription
NameThe name of the playbook run.
Owner User IDThe ID of the user who owns the playbook run.
Playbook IDThe ID of the playbook to use for this run.
Post IDThe ID of the post to use as the starting point for the run.
SummaryA summary of the playbook run.
Team IDThe ID of the team. Can be obtained from the List All Teams action.

Example Output

{
	"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": -9007199254740991,
	"delete_at": -9007199254740991,
	"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

Create Playbook Run with Mattermost and Send Results Via Email
Workflow LibraryPreview this Workflow on desktop