# Sync failure email notifications

## Introduction

Patchworks can send a daily email notification to specified users, to alert them when failed service syncs have occurred.  Optionally, this email includes a preview of the [sync report](https://doc.wearepatchworks.com/product-documentation/patchworks-services/reporting-and-logging/service-sync-reports) and should serve as a prompt for users to log into Patchworks and check the full report.

To implement sync failure notification emails, the following steps are required:

1.[ Add a notification group for required recipients](#adding-a-notification-group-for-required-recipients)

2\. [Associate this notification group with your company profile](#associating-a-notification-group-with-your-company-profile)

At this point, sync failure email notifications are configured and will be sent to recipients the next time sync failures occur. **By default, these emails will not include a preview of the sync report**. If you would like to switch this option on, complete the extra step below:

3\. [Choose whether or not to include a preview of the sync report in these emails](#switching-the-sync-failure-report-preview-on-off)

## Adding a notification group for required recipients

Please see our [notification groups](https://doc.wearepatchworks.com/product-documentation/patchworks-services/reporting-and-logging/service-sync-reports/broken-reference) page for instructions on adding notification groups and recipients. 

## Associating a notification group with your company profile  

Having defined a [notification group](https://doc.wearepatchworks.com/product-documentation/patchworks-services/reporting-and-logging/service-sync-reports/broken-reference) containing required recipients for sync failure emails, you need to associate that group with your company profile. To do this, follow the steps below:

**Step 1**\
Access your **company profile** page.

{% hint style="info" %}
Please see [accessing your company profile](https://doc.wearepatchworks.com/product-documentation/patchworks-services/reporting-and-logging/service-sync-reports/broken-reference) if you're not sure how to do this.
{% endhint %}

...the **manage profile** page is displayed - for example:

<figure><img src="https://content.gitbook.com/content/5mpqoXPMbUuPa8JpCLWe/blobs/2cysNO9NzBgnMLzHUKrH/my%20company%20profile%20page%20-%20alerts.png" alt=""><figcaption></figcaption></figure>

**Step 2**\
Move down to the **alerts notification group** panel, click the dropdown field and choose whichever [notification group](https://doc.wearepatchworks.com/product-documentation/patchworks-services/reporting-and-logging/service-sync-reports/broken-reference) you created for sync failure email alerts - for example:

<figure><img src="https://content.gitbook.com/content/5mpqoXPMbUuPa8JpCLWe/blobs/jCRuKR1gMeRnWnVv0HwT/choose%20group.png" alt=""><figcaption></figcaption></figure>

**Step 3**\
Scroll down and click the **save profile** button:\
![](https://content.gitbook.com/content/5mpqoXPMbUuPa8JpCLWe/blobs/2O8rUwDVqZsPAhfVyDtP/save%20profile.png)

**Step 4**\
At this point, sync failure email notifications are configured and will be sent to recipients the next time sync failures occur. By default, these emails will not include a preview of the sync report. If you would like to switch this option on, see: [switching the sync failure report preview on/off](#switching-the-sync-failure-report-preview-on-off).

## Switching the sync failure report preview on/off

To access settings for including/excluding a [sync report](https://doc.wearepatchworks.com/product-documentation/patchworks-services/reporting-and-logging/service-sync-reports) preview in sync failure emails, follow the steps below:

**Step 1**\
Access the [services list](https://doc.wearepatchworks.com/product-documentation/patchworks-services/working-with-services/the-services-list):

<figure><img src="https://content.gitbook.com/content/5mpqoXPMbUuPa8JpCLWe/blobs/l7CaBjzBF62UBE9oJ4lH/services%20list%20-%20no%20alerts.png" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
Please see [accessing services](https://doc.wearepatchworks.com/product-documentation/patchworks-services/working-with-services/accessing-services) if you're not sure how to get to this point.
{% endhint %}

**Step 2**\
Select the required service:

<figure><img src="https://content.gitbook.com/content/5mpqoXPMbUuPa8JpCLWe/blobs/WC49iUSFix3ENvDluaBG/select%20service%20-%20client%20admin%20-%20no%20alerts%20-%20inactive.png" alt=""><figcaption></figcaption></figure>

**Step 3**\
Click the **alerts** tab:

<figure><img src="https://content.gitbook.com/content/5mpqoXPMbUuPa8JpCLWe/blobs/DQ599E4poTlobzkolFPC/service%20setup%203.png" alt=""><figcaption></figcaption></figure>

...the **alerts** page is displayed:

<figure><img src="https://content.gitbook.com/content/5mpqoXPMbUuPa8JpCLWe/blobs/3e3l394oOKnQmpDeBKD6/service%20setup%203a.png" alt=""><figcaption></figcaption></figure>

**Step 4**\
Toggle the **include failures** in summary option off/on as required:

<figure><img src="https://content.gitbook.com/content/5mpqoXPMbUuPa8JpCLWe/blobs/bfk9uvR1EHZ3Xc9Krggw/service%20setup%204.png" alt=""><figcaption></figcaption></figure>

**Step 5**\
Click the **save** button.