# Configure Notifications

Shisho Cloud provides two types of notification features: **Real-time Notifications** and **Project Report Notifications**.

- **Real-time Notifications**: Sent when issues are detected or triaged, triggered by state changes.
- **Project Report Notifications**: Periodically summarize the current security status for each [project](https://cloud.shisho.dev/*/projects).

This page explains how to configure each notification type.

## Comparison of Notification Features

The following table summarizes the characteristics of each notification feature. Use them according to your needs.

| Feature                  | Real-time Notifications                             | Project Report Notifications         |
| :----------------------- | :-------------------------------------------------- | :----------------------------------- |
| **Primary Use Case**     | Notifications when issues are detected or triaged   | Periodic security status reporting   |
| **Notification Trigger** | When issues are detected or triaged                 | Scheduled (daily/weekly/monthly)     |
| **Notification Content** | Individual issues                                   | Project-wide summary and breakdown   |
| **Configuration Method** | Controlled via [workflows](/docs/g/concepts/workflow.md) | Configured via project settings page |
| **Customizability**      | High (flexible control via workflows)               | Medium (controlled via settings)     |

**Usage Examples**:

- **Real-time Notifications**: Send Slack notifications when Critical/High severity issues are found, or create tickets in your ticketing system.
- **Project Report Notifications**: Receive daily email reports of the entire project's security status for review in regular meetings.

## Configure Real-time Notifications

Real-time notifications are sent when issues are detected or triaged, triggered by state changes.

Shisho Cloud allows you to flexibly control the timing and content of notifications through [workflows](/docs/g/concepts/workflow.md). For ease of use without complex configuration, a default **notification workflow** is provided, which sends notifications based on the **severity** of detected issues.

**Example Slack Notification**

![](/docs/_md-assets/149b4d470c-notification-default-slack.png)

**Example Email Notification**

![](/docs/_md-assets/d22fc520f6-notification-default-email.png)

### Notification Workflows

There are two types of notification workflows: organization-wide notifications and project-specific notifications. Both send notifications when issues are detected or triaged.

<Tabs groupId="notification-workflows" queryString>
  <TabItem value="notification_workflow" label="Notification Workflow" default>

The [notification workflow](https://cloud.shisho.dev/*/workflows/edit?wfid=notification-security) is a standard workflow included in Shisho Cloud. It sends notifications when issues are detected or triaged for all resources within the organization, using the following delivery methods:

- Notifications to Slack channels
- Emails to designated addresses
- Notifications to destinations associated with notification groups

:::warning
Some users may have a workflow distributed that only supports **Slack notifications**. In that case, please open the standard [notification workflow](https://cloud.shisho.dev/*/workflows/edit?wfid=notification-security) page, copy and paste the following new workflow to replace the existing one. After replacing the workflow, you will need to specify the notification destinations again. Please specify them in the [parameter settings](#edit-notification-parameter) on the standard [notification workflow](https://cloud.shisho.dev/*/workflows/edit?wfid=notification-security) page.
:::

<CodeBlock language="yaml">{ManifestNotificationSecurity}</CodeBlock>

  </TabItem>
  <TabItem value="notification_workflow_per_project" label="Per-Project Notification Workflow">

The **per-project notification workflow** sends notifications to various destinations when issues are detected or triaged within the scope (resources) of a project. This workflow is not included by default, so if necessary, please copy and create a new workflow using the following YAML:

<CodeBlock language="yaml">{ManifestNotificationProjectSecurity}</CodeBlock>

  </TabItem>
</Tabs>

Let's take a look at how to configure notifications.

### Configuring the Notification Workflow

This section explains how to modify the notification workflow settings and configure notifications for when issues are detected and triaged.

#### Accessing the Notification Workflow Settings Page

Go to the [notification workflow editing page](https://cloud.shisho.dev/*/workflows/edit?wfid=notification-security). You should see the following screen:

![](/docs/_md-assets/a931eef048-notification-workflow.png)

#### Editing Parameters {#edit-notification-parameter}

In the upper right corner of the screen, you'll find settings for various notification destinations and the severity levels of detected issues that trigger notifications. Configure each item and click **Save**.

![](/docs/_md-assets/bdd2a6e877-notification-workflow-2.png)

:::warning
To configure notifications, you need to configure various **notification targets** beforehand. For details, see [here](/docs/g/concepts/notification.md).
:::

#### Testing Slack Notifications

To use Slack channel notifications, you can send a test notification by clicking the **Send Test Notification** button. If you see a message like the one below, your notification settings are complete.

![](/docs/_md-assets/e658d23787-notification-default-test.png)

### Configuring Per-Project Notification Workflows

In some cases, you may want to send notifications to the same destination, while in other cases, you may want to send notifications to different destinations for each project. In such cases, use the [per-project notification workflow](/docs/g/getting-started/setup-notification.md?notification-workflows=notification_workflow_per_project) described above.

#### Accessing the Settings Page of the Target Project

First, from the [project list screen](https://cloud.shisho.dev/*/projects), select the project you want to configure notifications for and go to the settings page.

![](/docs/_md-assets/36cd02e46c-notification-default-project-channels-1.png)

#### Configuring Notification Destinations

On the settings page, select the desired notification destination and add or update it.

![](/docs/_md-assets/5fc29b3038-notification-project-channels.png)

The following can currently be added as project notification destinations. Each of these needs to be configured in advance, so if your desired notification destination is not displayed as an option, please check the configuration.

- Slack channels: See "Setting Up Slack Notifications" in [Notification Targets](/docs/g/concepts/notification.md).
- Notification groups: See [Configuring Notification Groups](/docs/g/concepts/notification-group.md).
- Email: See "Setting Up Email Notifications" in [Notification Targets](/docs/g/concepts/notification.md).

#### Accessing the Per-Project Notification Workflow Settings Page

Since you have already configured the **notification destinations** on the project settings page, you do not need to configure them again using parameters. If you want to change the severity of detected issues that trigger notifications, go to the **per-project notification workflow** edit page and edit the parameters.

![](/docs/_md-assets/01190ec8ff-notification-default-project-channels-3.png)

## Configure Project Report Notifications

Project report notifications periodically send security status reports for your projects. Select the target project from the [project list](https://cloud.shisho.dev/*/projects) and open the settings page.

**Example Slack Notification**

![](/docs/_md-assets/3d55eabde9-notification-project-report-slack.png)

**Example Email Notification**

![](/docs/_md-assets/e964f06489-notification-project-report-email.png)

### Configure Notification Destinations

Notifications are sent to the default notification destinations for each project. If you haven't registered any yet, please register notification destinations.

![](/docs/_md-assets/5fc29b3038-notification-project-channels.png)

:::warning
If no notification destinations are configured, notifications will not be sent even if this feature is enabled. Please register at least one notification destination.
:::

### Enable and Configure Project Report Notifications

In the notification settings, turn on the toggle for the notifications you want to receive. Currently, we provide a "Security Status Report by Resource Kind" that aggregates findings by **resource kind**.

**Security Status Report by Resource Kind Configuration**

You can configure the following settings. Change them as needed and click the Save button.

![](/docs/_md-assets/64aeb84bea-notification-project-report-configs.png)

:::info
Currently, only **daily reports** are supported. Weekly and monthly reports will be supported in the future.
:::

:::info
Reports only include findings with the status **Awaiting Review** or **Action Needed**.
:::

:::warning
For email notifications, if the HTML email exceeds a certain size, it will automatically be sent in plain text format. Please be aware of this in advance.
:::