240db4e2a7
Some checks failed
Server CI / Postgres (shard 0) (push) Has been skipped
Server CI / Postgres (shard 3) (push) Has been skipped
BuildEnv Docker Image / build-image (push) Failing after 4s
BuildEnv Docker Image / build-image-fips (push) Failing after 4s
Migration Review & Release Notes / Generate migration review & release notes (push) Failing after 3s
Server CI / Build Environment (push) Failing after 3s
Server CI / Postgres (shard 1) (push) Has been skipped
Tools CI / check-style (mattermost-govet) (push) Failing after 4s
Server CI / Postgres (shard 2) (push) Has been skipped
Tools CI / check-style (mmgotool) (push) Failing after 3s
Server CI / Elasticsearch v8 Compatibility (push) Has been skipped
Server CI / OpenSearch v2 Compatibility (push) Has been skipped
Server CI / Postgres FIPS (shard 0) (push) Has been skipped
Tools CI / Test (mattermost-govet) (push) Failing after 3s
Server CI / Postgres FIPS (shard 1) (push) Has been skipped
Server CI / Postgres FIPS (shard 2) (push) Has been skipped
Tools CI / Test (mmgotool) (push) Failing after 3s
Server CI / Postgres FIPS (shard 3) (push) Has been skipped
Server CI / Run mmctl tests (push) Has been skipped
Server CI / Run mmctl tests (FIPS) (push) Has been skipped
Server CI / Merge Postgres Test Results (push) Has been skipped
Server CI / Merge Postgres FIPS Test Results (push) Has been skipped
Server CI / Check backport migrations (push) Has been skipped
Server CI / Check generated files (push) Has been skipped
Server CI / check-style (push) Has been skipped
Server CI / Vet API (push) Has been skipped
Server CI / Build mattermost server app (push) Has been skipped
Server CI / Server CI Complete (push) Failing after 2s
Server CI / Server CI Artifacts (push) Has been skipped
Server CI / Sentry Upload (push) Has been skipped
Server CI / Server CI Report (push) Failing after 5m1s
Server CI Nightly Race / Race Detector (push) Has been skipped
CodeQL / Analyze (go) (push) Has been cancelled
CodeQL / Analyze (javascript) (push) Has been cancelled
Webapp CI Cache Warm / Warm Webapp node_modules Cache (push) Has been cancelled
E2E CI Cache Warm / Warm E2E npm Registry Cache (push) Has been cancelled
API / build (push) Has been cancelled
Web App CI / check-types (push) Has been cancelled
Web App CI / check-lint (push) Has been cancelled
Web App CI / check-i18n (push) Has been cancelled
Web App CI / check-external-links (push) Has been cancelled
Web App CI / test (platform) (push) Has been cancelled
Web App CI / test (mattermost-redux) (push) Has been cancelled
Web App CI / test (channels shard 1/4) (push) Has been cancelled
Web App CI / test (channels shard 2/4) (push) Has been cancelled
Web App CI / test (channels shard 3/4) (push) Has been cancelled
Web App CI / test (channels shard 4/4) (push) Has been cancelled
Web App CI / upload-coverage (push) Has been cancelled
Web App CI / build (push) Has been cancelled
YAML Lint / yamllint (push) Has been cancelled
Push mirrored docker images / cd/Push mirrored docker images (push) Has been cancelled
docs-cd / Build and deploy docs (push) Has been cancelled
Docs CI / build (push) Has been cancelled
E2E Cache Warm: Cypress deps / Warm Cypress deps cache (push) Has been cancelled
Scorecards supply-chain security / Scorecard analysis (push) Has been cancelled
Server CI Weekly / Postgres FIPS (push) Has been skipped
Server CI Weekly / Run mmctl tests (FIPS) (push) Has been skipped
Server CI Weekly / Postgres with binary parameters (push) Has been skipped
Server CI Weekly / Build Environment (push) Failing after 1s
Server CI Cache Warm / Warm Go Module and Build Cache (push) Failing after 2s
Server CI Nightly Race / Build Environment (push) Failing after 1s
34 lines
1.9 KiB
Plaintext
34 lines
1.9 KiB
Plaintext
---
|
|
title: "Interact with playbooks"
|
|
---
|
|
<PlanAvailability slug="entry-ent" />
|
|
|
|
## Slash commands
|
|
|
|
Slash commands are available for collaborative playbooks. The `/playbook` slash command allows interaction with incidents via the post textbox on desktop, browser, and mobile. To run a playbook use the `/playbook run` slash command from any channel.
|
|
|
|
Available slash commands include:
|
|
|
|
- `/playbook run` - Run a playbook.
|
|
- `/playbook finish` - Finish the playbook run in this channel.
|
|
- `/playbook update` - Provide a status update.
|
|
- `/playbook check [checklist #] [item #]` - Check/uncheck the checklist item.
|
|
- `/playbook checkadd [checklist #] [item text]` - Add a checklist item.
|
|
- `/playbook checkremove [checklist #] [item #]` - Remove a checklist item.
|
|
- `/playbook owner [@username]` - Show or change the current owner.
|
|
- `/playbook info` - Show a summary of the current playbook run.
|
|
- `/playbook timeline` - Show the timeline for the current playbook run.
|
|
- `/playbook todo` - Get a list of your assigned tasks.
|
|
- `/playbook settings digest [on/off]` - Turn daily digest on/off.
|
|
- `/playbook settings weekly-digest [on/off]` - Turn weekly digest on/off.
|
|
|
|
## Playbooks on the go
|
|
|
|
Learn how to [access and work with playbooks on the go](/end-user-guide/workflow-automation/work-with-runs#playbook-runs-on-mobile) with the Mattermost mobile app.
|
|
|
|
## API documentation
|
|
|
|
To interact with the data model programmatically, consult the [REST API specification](https://github.com/mattermost/mattermost-plugin-incident-collaboration/blob/master/server/api/api.yaml).
|
|
|
|
Playbooks help streamline and manage complex processes while decreasing the risk of forgotten steps or tasks. They also support tool integration, status updates in a dedicated channel, and can be edited on the fly. When a playbook run is finished, you can review the entire run to assess any areas of improvement for the next run.
|