Files
team/docs/main/recipes/product-vulnerability-incident.mdx
bc56925599 feat(docs): move docs-experimental content into monorepo docs/ (#37330)
* feat(docs): move docs-experimental content into monorepo docs/

* Remove plan related files and comments

* Cleanup comments, remove generated files

---------

Co-authored-by: Hanzo Dev <[email protected]>
2026-07-02 18:42:57 +03:00

79 lines
6.1 KiB
Plaintext
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
---
title: "Mattermost Recipe: How to use Mattermost for product vulnerability incidents"
---
## Problem
After getting access to your Mattermost instance, you’d like to set up a workflow for security incident handling using Mattermost. Visit our [deployment section](https://mattermost.com/download/) if you want to learn more about how to deploy your own Mattermost instance.
## Solution
This guide walks through the set up of a product security incident room using [Collaborative Playbooks](/end-user-guide/workflow-automation) and [Channels](/end-user-guide/messaging-collaboration) with voice calling and screen sharing functionalities.
### 1. Workspace setup
For Cloud customers, all the functionalities works out-of-the-box with no technical setup. Simply invite your team members to your workspace and move onto the next section. For self-hosted deployments, refer to the [calls configuration documentation](/administration-guide/configure/plugins-configuration-settings#calls) to configure voice calling and screen sharing.
### 2. Playbooks setup
Now that your [workspace](/end-user-guide/end-user-guide-index) and teammates are ready, the next step is to create a playbook for incident handling. For this recipe, we're using an adapted playbooks template used by the Mattermost Product Security team that's available for [download here](https://github.com/mattermost/mattermost-security/blob/master/product_security/playbooks/security_vulnerability_playbook.json).
After downloading the template above, connect to your Mattermost [workspace](/end-user-guide/end-user-guide-index). Then open the product menu and select **Playbooks**.
![From the product menu, select Playbooks.](/images/recipe/prod-vuln-incident1.png)
Next, open the **Playbooks** menu, select **Import**, and navigate to the file you downloaded.
![Select the Playbooks tab, select Import, and go to the template file you downloaded.](/images/recipe/prod-vuln-incident2.png)
When you've imported the file, you should have a new playbook called **Security Vulnerability Playbook**. Select the three dots to edit the playbook.
![Select the three dots next to the new Security Vulnerability Playbook you imported.](/images/recipe/prod-vuln-incident3.png)
Modify any tasks or actions to suit your use case. In our scenario, we’ve assigned the playbook owner role by default to Alice and added three other team members to be automatically added in the **Actions** tab. We recommend changing these to the members of your security team.
![Select Actions to assign a playbook owner role and add other team members from the security team](/images/recipe/prod-vuln-incident4.png)
Select **Save**. Then, hit **Run**.
![Save your changes then run the playbook by selecting Run.](/images/recipe/prod-vuln-incident5.png)
Set the title on a scenario that makes sense for your environment and select **Start Run** to create a new channel and invite the members as you’ve predefined.
![Give your playbook run a name. When you select Start Run, a new channel is created and members are invited based on how you set up the playbook.](/images/recipe/prod-vuln-incident6.png)
### 3. Using calls for voice chat and screen sharing
For Mattermost Enterprise and Professional customers, you can select **Start call** in the run channel header to kick-off a channel call. The call can only be joined by participants of the incident channel.
![If you're running Mattermost Enterprise or Professional, select Start Call in the channel header that other channel participants can join.](/images/recipe/prod-vuln-incident7.png)
In the bottom-left corner of Mattermost, select the expand icon to open a separate pop-out window for the call, with additional options to start presenting.
![In a call, expand the call screen using the Expand icon. Expanding the call also provides you with additional options to share your screen.](/images/recipe/prod-vuln-incident8.png)
For Mattermost Team Edition, only 1:1 calls are supported. Open a direct message with another incident responder and follow the same steps as above.
<Note>
Want to try out calls? Select **Start call** in the incident channel to start a free 30-day trial of Mattermost Enterprise to enable this functionality for all channels.
</Note>
## Discussion
Using collaborative playbooks you can ensure a streamlined approach to incident resolution. Our playbook template walks through a typical product vulnerability remediation aims to provide a structure resolution and also keeping the right stakeholder informed.
The playbook starts with a **Triage** stage that verifies the validity of the issue, continues with an **Investigation** of exploitation (if possible) and follows with an active **Remediation** of the issue. After the issue is mitigated, the incident can go into **Resolution** and be closed with an incident post-mortem.
When running the playbook, you can add key events, such as messages, to the timeline for easier reporting. To do so, select the app icon when hovering over a message.
![When running a playbook, add key events to the timeline by hovering over a message and selecting the App icon.](/images/recipe/prod-vuln-incident9.png)
Give it a short summary that will be shown on the incident overview, with the ability to jump to the message linked.
![Provide a short summary visible on the incident overview. When you publish the message to the timeline, other users will be able to jump to the linked message.](/images/recipe/prod-vuln-incident10.png)
The timeline is a great feature to provide an overview of the most significant events for both active and previous events for both responders and for management.
The process and playbook shared here is only the starting point for your unique environment. By [customizing the playbooks](https://mattermost.com/blog/getting-started-with-playbooks/) and [adding additional integrations](https://mattermost.com/blog/how-to-make-your-incident-response-plan-with-mattermost/) to automatically be notified about new incidents you can further accelerate your response times. Additional integrations with SIEM solutions and platforms such as HackerOne will be released in the next months.