/
MA
mattermost
/
Playbooks API
Search skmtc…
⌘K
Changes
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Filter operations
Conditions
5
Internal
4
PlaybookAutofollows
1
PlaybookRuns
23
get
/plugins/playbooks/api/v0/runs
List all playbook runs
post
/plugins/playbooks/api/v0/runs
Create a new playbook run
get
/plugins/playbooks/api/v0/runs/owners
Get all owners
get
/plugins/playbooks/api/v0/runs/channels
Get playbook run channels
get
/plugins/playbooks/api/v0/runs/channel/{channel_id}
Find playbook run by channel ID
get
/plugins/playbooks/api/v0/runs/{id}
Get a playbook run
patch
/plugins/playbooks/api/v0/runs/{id}
Update a playbook run
get
/plugins/playbooks/api/v0/runs/{id}/metadata
Get playbook run metadata
put
/plugins/playbooks/api/v0/runs/{id}/end
End a playbook run
put
/plugins/playbooks/api/v0/runs/{id}/restart
Restart a playbook run
post
/plugins/playbooks/api/v0/runs/{id}/status
Update a playbook run's status
put
/plugins/playbooks/api/v0/runs/{id}/finish
Finish a playbook
post
/plugins/playbooks/api/v0/runs/{id}/owner
Update playbook run owner
post
/plugins/playbooks/api/v0/runs/{id}/checklists/{checklist}/add
Add an item to a playbook run's checklist
put
/plugins/playbooks/api/v0/runs/{id}/checklists/{checklist}/reorder
Reorder an item in a playbook run's checklist
put
/plugins/playbooks/api/v0/runs/{id}/checklists/{checklist}/item/{item}
Update an item of a playbook run's checklist
delete
/plugins/playbooks/api/v0/runs/{id}/checklists/{checklist}/item/{item}
Delete an item of a playbook run's checklist
put
/plugins/playbooks/api/v0/runs/{id}/checklists/{checklist}/item/{item}/state
Update the state of an item
put
/plugins/playbooks/api/v0/runs/{id}/checklists/{checklist}/item/{item}/assignee
Update the assignee of an item
put
/plugins/playbooks/api/v0/runs/{id}/checklists/{checklist}/item/{item}/run
Run an item's slash command
get
/plugins/playbooks/api/v0/runs/{id}/property_fields
Get property fields for a playbook run
get
/plugins/playbooks/api/v0/runs/{id}/property_values
Get property values for a playbook run
put
/plugins/playbooks/api/v0/runs/{id}/property_fields/{field_id}/value
Set a property value for a playbook run
Playbooks
10
Timeline
1
PlaybookRuns
Copy Markdown
Copied
Copy failed
Changes to Get playbook run channels
get
/plugins/playbooks/api/v0/runs/channels
Jun 19, 2023
148981c0ea86
Revision changes
○
endpoint added