# 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](/product-documentation/patchworks-services/reporting-and-logging/service-sync-reports.md) 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](broken://pages/ul3TLNVYRLYUGugTOFLU) page for instructions on adding notification groups and recipients.&#x20;

## Associating a notification group with your company profile &#x20;

Having defined a [notification group](broken://pages/ul3TLNVYRLYUGugTOFLU) 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](broken://pages/Ys41Bj2v3AXI4s020odl) if you're not sure how to do this.
{% endhint %}

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

<figure><img src="/files/81cJ7MYEsGZB8jsE8ogF" alt=""><figcaption></figcaption></figure>

**Step 2**\
Move down to the **alerts notification group** panel, click the dropdown field and choose whichever [notification group](broken://pages/ul3TLNVYRLYUGugTOFLU) you created for sync failure email alerts - for example:

<figure><img src="/files/L4vqD1hewf4lZrDjsPak" alt=""><figcaption></figcaption></figure>

**Step 3**\
Scroll down and click the **save profile** button:\
![](/files/SNkEEC3g2yjfmaMNHjpb)

**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](/product-documentation/patchworks-services/reporting-and-logging/service-sync-reports.md) preview in sync failure emails, follow the steps below:

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

<figure><img src="/files/yr8fjq0Kzt6Vpm41Tum4" alt=""><figcaption></figcaption></figure>

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

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

<figure><img src="/files/iwLC4LXtn7YCTQGtmcMv" alt=""><figcaption></figcaption></figure>

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

<figure><img src="/files/GzRcerY7WfeYpACdaXOw" alt=""><figcaption></figcaption></figure>

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

<figure><img src="/files/pehz9K0ThDvrirbbIUDD" alt=""><figcaption></figcaption></figure>

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

<figure><img src="/files/xHq2x2V076kJTGB1Yo8M" alt=""><figcaption></figcaption></figure>

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


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://doc.wearepatchworks.com/product-documentation/patchworks-services/reporting-and-logging/service-sync-reports/sync-failure-email-notifications.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
