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
91 lines
5.0 KiB
Plaintext
91 lines
5.0 KiB
Plaintext
---
|
||
title: "Work with notifications and updates"
|
||
---
|
||
import useBaseUrl from '@docusaurus/useBaseUrl';
|
||
import Tabs from '@theme/Tabs';
|
||
import TabItem from '@theme/TabItem';
|
||
|
||
<PlanAvailability slug="entry-ent" />
|
||
|
||
There are multiple ways to receive collaborative playbook updates and notifications.
|
||
|
||
## Status updates
|
||
|
||
Status updates ensure that stakeholders remain informed about the playbook run's progress.
|
||
|
||
You can post a status update from the run channel and you can also configure the playbook to send a reminder to post a status update.
|
||
|
||
<Tabs>
|
||
<TabItem value="web-and-desktop" label="Web and Desktop">
|
||
|
||
1. To post a status update, access the **Playbooks** tab in Mattermost. Select the run you want to post the update for. In the run details page, select **Post update**.
|
||
- If this is the first status update and the playbook has a defined template, that template will be pre-populated here.
|
||
- If this is a subsequent status update, the message from the last status update will be pre-populated here.
|
||
2. Optionally set a reminder to prompt for the next status update.
|
||
- If this is the first status update and the playbook has a defined default reminder timer, that timer will be pre-selected here.
|
||
- If this is a subsequent status update, the last reminder timer will be pre-populated here.
|
||
3. Select **Post update** to post your status update.
|
||
|
||
</TabItem>
|
||
<TabItem value="mobile" label="Mobile">
|
||
|
||
From Mattermost v11.1 and mobile v2.34.0, mobile users can post status updates directly from the Mattermost mobile app:
|
||
|
||
1. Open a playbook run from your mobile app.
|
||
2. Select the status update button that appears when viewing the run details.
|
||
3. In the status update modal:
|
||
- If this is your first status update and the playbook has a status update template, the template content will be pre-populated.
|
||
- For subsequent updates, your most recent status update content will be pre-populated.
|
||
- The modal header shows how many people and channels will receive your status update.
|
||
4. Select your reminder timing from the predefined options available in the mobile app.
|
||
5. Select **Post update** to share your status update.
|
||
|
||
<Note>
|
||
|
||
- The status update button is only available to participants in the playbook run and is disabled when the run is finished.
|
||
- Mobile time selector options are limited to predefined choices, unlike the web interface which allows custom date entry.
|
||
|
||
</Note>
|
||
|
||
</TabItem>
|
||
</Tabs>
|
||
|
||
|
||
When the playbook has a defined broadcast channel, status updates are copied to the broadcast channel as a message from the Playbooks bot. Status updates broadcast to another channel won’t be updated or removed if the original post is edited or deleted.
|
||
|
||
The most recent status post alsos displays in the right-hand sidebar of the run channel and in the timeline. To correct or remove a status post, edit or delete the post as needed.
|
||
|
||
## Request an update
|
||
|
||
To request a status update, access the **Playbooks** tab in Mattermost. Select the run you want an update for. In the run details page, select the <img src={useBaseUrl('/img/ui/dots-vertical_F01D9.svg')} alt="Use the More icon in the top left corner to access Mattermost desktop apps customization settings." className="theme-icon" /> menu next to **Post update** and select **Request update**.
|
||
|
||
<Note>
|
||
|
||
Requesting updates is only available in the web browser and desktop app. This functionality is not available on mobile.
|
||
|
||
</Note>
|
||
|
||
## Follow runs and playbooks
|
||
|
||
Follow specific playbooks to receive updates on important events such as when a run is started and finished, as well as status and retrospective updates every time that playbook is run. This is a good option if you're interested in all instances of a specific workflow, such as an outage resolution playbook.
|
||
|
||
You can also choose to follow a specific run without actively participating. You’ll receive updates for that run only and can take action if needed. This is useful when you’re only interested in a single instance of a procedure—for example, following onboarding for one specific customer rather than every onboarding run.
|
||
|
||
<Note>
|
||
|
||
Following playbooks and runs is only available in the web browser and desktop app. This functionality is not available on mobile.
|
||
|
||
</Note>
|
||
|
||
## Daily digest
|
||
|
||
To help you keep track of your runs, tasks, and statuses, a daily digest is sent via direct message in Mattermost.
|
||
|
||
Running playbooks in multiple channels can be overwhelming. The daily digest is sent once a day, in the morning. It lists the actionable items for each run, as well as any outstanding tasks or status updates required. Select the run name to move to that channel.
|
||
|
||
The digest is on by default. To turn it off, use the slash command `/playbook settings digest off`.
|
||
|
||
## Playbook to do
|
||
|
||
As you complete tasks and finish runs, you can update the details in the digest using the slash command `/playbook todo`. This slash command can be run in any channel, direct message, or group message. Once run, it delivers an updated digest which includes a list of active runs you belong to.
|