> For the complete documentation index, see [llms.txt](https://docs.brigge.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.brigge.ai/documentation/brigge-for-transformers/pipelines/pipeline-nodes/notification-node.md).

# Notification node

## Overview

The *Notification* node sends an alert at a defined point in a pipeline run. Use it to notify a person or system when something happens - for example, when certain records are found, a check fails, or a run completes.

{% hint style="info" %}
One notification is triggered for every payload that the `notification` node receives.
{% endhint %}

## Notification types

You can choose how notifications are delivered from the following notification types:

<table><thead><tr><th width="229.173583984375">Notification type</th><th>Summary</th></tr></thead><tbody><tr><td>Email</td><td>Sends the notification to the members of the selected notification group. Notification groups are defined in <a href="/documentation/brigge-settings.md">Brigge settings</a>.<br><br>Notification group members will only receive these messages if they have opted in to Brigge notifications. </td></tr><tr><td>Webhook</td><td>Posts the notification to an external endpoint.</td></tr></tbody></table>

## Notification content

You can provide notification content (for email and webhook notifications) in two ways:

<table><thead><tr><th width="229.173583984375">Content type</th><th>Summary</th></tr></thead><tbody><tr><td>Notification template</td><td>A predefined template. Notification templates are defined in <a href="/documentation/brigge-settings.md">Brigge settings</a>.</td></tr><tr><td>Content</td><td>Write the subject and body directly in notification settings.</td></tr></tbody></table>

## Configuring notifications

<div align="left" data-with-frame="true"><figure><img src="https://2172380191-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F8IqdqwZowcxtFpZfLa6k%2Fuploads%2F8IZWik82sRPfBWBDzkUR%2FNotification%20node%20summary.svg?alt=media&amp;token=50e97391-5aea-4a62-933b-b28399767f5c" alt=""><figcaption></figcaption></figure></div>

Configuration options for the `notification` node are summarised below:

{% stepper %}
{% step %}
**Notification type**

Select the required notification type (`email` or `webhook`).

{% hint style="info" %}
If necessary, you can define both notification types.
{% endhint %}
{% endstep %}

{% step %}
**Content type**

Choose how you want to provide content for these notifications. If you have an existing template for these notifications, select [notification template](#notification-template). Otherwise, select the [content](#content) option to add the required content directly.
{% endstep %}

{% step %}
**Content**

Options for providing content vary, depending on the content type selected in step 2.

<details>

<summary>Notification template  </summary>

After selecting `notification template`, you are prompted to select an existing template. For example:

<div align="left" data-with-frame="true"><figure><img src="https://2172380191-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F8IqdqwZowcxtFpZfLa6k%2Fuploads%2FEPE5gKBsuEuTGM0VlrAk%2Fselect%20notification%20template.png?alt=media&amp;token=c38d72a6-6d2e-460c-8ec2-5c77bd33043e" alt="" width="563"><figcaption></figcaption></figure></div>

Choose the required template and continue with the node configuration.

</details>

<details>

<summary>Content</summary>

Click the `open full-screen editor` button to access a [Markdown](https://en.wikipedia.org/wiki/Markdown#Examples) editor:

<div align="left" data-with-frame="true"><figure><img src="https://2172380191-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F8IqdqwZowcxtFpZfLa6k%2Fuploads%2FvYZlyOIgj9YDcLBkpHOJ%2Ffull%20screen%20editor.png?alt=media&amp;token=886e2ea4-11f5-4df9-bc57-1ebc453739d2" alt="" width="563"><figcaption></figcaption></figure></div>

{% hint style="info" %}
This editor is used for both `email` and `webhook` notification types.&#x20;

For emails, this content is added to the email body. Additionally, you'll see a `subject` field, so you can provide a subject for the email message. For webhooks, this content is added to the webhook body.
{% endhint %}

Provide required Markdown in the `content` tab. You can use the `preview` tab to see how this will be rendered:

<div data-with-frame="true"><figure><img src="https://2172380191-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F8IqdqwZowcxtFpZfLa6k%2Fuploads%2FyMn1ZOMxW9OA6m5oaQiN%2Fnotification%20content%20editor%20a.png?alt=media&amp;token=c118ef33-3391-4ba4-9ebb-8926c9c30cf4" alt=""><figcaption></figcaption></figure></div>

{% hint style="info" %}
Some useful Markdown conventions are listed below:

```
# Heading 1
## Heading 2
### Heading 3

Paragraphs are separated by a blank line.  

This is _italic text_  
This is **bold text**
* This is bullet item 1
* This is bullet item 2

1. This is numbered item 1
2. This is numbered item 2
```

{% endhint %}

</details>
{% endstep %}

{% step %}
**Finish configuration**

Final configuration options vary, depending on the notification type selected in step 1.

<details>

<summary>Email</summary>

**Payload attachments**

It's often useful to attach incoming payloads to notification messages. To do this, toggle on the `use the passed payload as a file attachment` setting. Optionally, you can set your preferred filename for payload attachments. For example:

<div data-with-frame="true"><figure><img src="https://2172380191-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F8IqdqwZowcxtFpZfLa6k%2Fuploads%2Fg8AlETFSzJrYoNqZjz9T%2Fnotifications%20-%20attach%20payloads.png?alt=media&amp;token=888e6568-a5b0-4709-aade-ae256750fff0" alt=""><figcaption></figcaption></figure></div>

**Notification recipients**

Click the `+` symbol in the `notification groups` section:

<div data-with-frame="true"><figure><img src="https://2172380191-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F8IqdqwZowcxtFpZfLa6k%2Fuploads%2FP5nCgAw6YsTDcpxNKK0h%2Fadd%20notification%20group%201.png?alt=media&amp;token=1643430e-b77c-4e6f-acb8-01e2996b6663" alt=""><figcaption></figcaption></figure></div>

Then select a `notification group` from the dropdown list. Optionally, you can choose to only notify this group when the pipeline runs in a specific [environment](/documentation/brigge-for-transformers/environments.md) (the default setting is to trigger notifications when the pipeline runs in all environments).

<div data-with-frame="true"><figure><img src="https://2172380191-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F8IqdqwZowcxtFpZfLa6k%2Fuploads%2F7ggkD6EEPX9GDL8VcKWD%2Fadd%20notification%20group%202.png?alt=media&amp;token=c161e1d5-5560-40c3-8160-d11476ecbcd4" alt=""><figcaption></figcaption></figure></div>

{% hint style="warning" %}
One notification email is triggered for every payload that the `notification` node receives. For example, if 10 payloads hit the `notification` node, then each recipient receives 10 emails.
{% endhint %}

{% hint style="info" %}
Notification groups and associated recipients are defined in [Brigge settings](/documentation/brigge-settings.md). You can add as many notification groups as needed.
{% endhint %}

</details>

<details>

<summary>Webhook</summary>

Click the `+` symbol in the `webhooks` section:

<div data-with-frame="true"><figure><img src="https://2172380191-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F8IqdqwZowcxtFpZfLa6k%2Fuploads%2FdfssnQGug4AtUsNk9Wwt%2Fadd%20webhook%20a.png?alt=media&amp;token=e28e655a-8f13-4e4e-a0aa-6177849194dc" alt=""><figcaption></figcaption></figure></div>

Then update the `webhook URL` field with your required URL. Optionally, you can choose to only fire this webhook when the pipeline runs in a specific [environment](/documentation/brigge-for-transformers/environments.md) (the default setting is to fire when the pipeline runs in all environments).

<div data-with-frame="true"><figure><img src="https://2172380191-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F8IqdqwZowcxtFpZfLa6k%2Fuploads%2FyaYVpSPLUBcinMsWPGkN%2Fadd%20webhook%20b.png?alt=media&amp;token=242f3fe8-e6c8-46dd-acb5-140efe45f108" alt=""><figcaption></figcaption></figure></div>

{% hint style="info" %}
You can add as many webhooks as needed.
{% endhint %}

{% hint style="warning" %}
For each defined webhook, one notification is triggered for every payload that the `notification` node receives. For example, if 10 payloads hit the `notification` node then each webhook is fired 10 times.
{% endhint %}

</details>
{% endstep %}
{% endstepper %}
