Search documentation...

K

Overview

You can set alerts to inform you of problems with your syncs. Hightouch supports sending error alert notifications through SMS, Slack, email, and PagerDuty.

Setup

Setting up alerting requires two steps: (1) Setup error alerts in your main workspace settings; (2) Setup error alerts for each sync. Both steps are required.

Setup error alerts in your main workspace

To begin, visit the 'Integrations' tab in your main workspace settings and enter your credentials for your preferred alerting provider (Slack or PagerDuty) under the 'Alert Credentials' section. This step is not needed if you plan to enable SMS or email alerts.
Then, visit the 'Alerts' tab in your workspace's main settings to set up your workspace's default alerts.
Click on 'Add alerts' and input the data required for your choice of alert: SMS, Slack, email, or PagerDuty. If you added credentials in step 1 for Slack or PagerDuty, those credentials will pre-populate the drop-down menu here.
A 'fatal error' is an error communicating with either a source or destination. It is 'fatal' because the sync can't even run.
A 'row error' means there's a problem with syncing a row (or record). The sync works, but a row has failed.
Setting the 'Minimum Alert Interval' allows you to receive alerts at spaced intervals; once every hour, for instance.
You can create multiple alerts for different types of severity. For instance, perhaps you use PagerDuty for fatal alerts and Slack for row alerts.
Once you have default alerts set up in your workspace's main settings, you are ready for step two, which is to enable an alert (or alerts) in your sync.

Setup error alerts for a sync

Visit the 'Alerts' tab in your sync's settings area:
The default alerts you set up in your workspace's settings will automatically be listed.
From here, you can modify the default behavior of an alert by selecting or deselecting if it's active for a 'fatal error' or a 'row error' or both. You will also see a record of when the alert was last attempted.
You can also set an alert threshold so that you're only notified when the sync errors are above a certain percentage of either total queried rows or total synced rows. This feature is useful when you expect that a certain number of rows/records will regularly fail and you don't wish to be notified unless the number of errors is significant.
Once you've configured your alert settings in the sync, don't forget to click 'save':

Example: Creating a Slack Alert with Templated Error Information

To create a Slack error alert that contains information about the erroring sync, reference id, url, and error as templated variables in your block kit code:
[
  {
    "type": "section",
    "text": {
      "type": "mrkdwn",
      "text": "Sync: <{{ url }}>, id: {{ id }} failed with error: {{ error }}"
    }
  }
]
Note: You do not need to include the entire block kit object, just the array in the "blocks" field as shown above. See the documentation for our Slack destination for more details about working with Slack's block kit.

    Need help?

    Our team is relentlessly focused on your success. We're ready to jump on a call to help unblock you.

    • Connection issues with your data warehouse?
    • Confusing API responses from destination systems?
    • Unsupported destination objects or modes?
    • Help with complex SQL queries?

    or

    Feature Requests?

    If you see something that's missing from our app, let us know and we'll work with you to build it!

    We want to hear your suggestions for new sources, destinations, and other features that would help you activate your data.

On this page

OverviewSetupSetup error alerts in your main workspaceSetup error alerts for a syncExample: Creating a Slack Alert with Templated Error Information

Was this page helpful?