Search documentation...

K

Alerting

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 alerts involves two steps:

  1. General configuration in your workspace
  2. Setting up alerts for each sync you'd like alerting on

Both are required.

General configuration

  1. Navigate to the Extensions page and select Alerting.
  2. If you plan on using either Slack or PagerDuty, click Configure extension. Click Set up below your preferred alert provider and either authorize Slack or provide your PagerDuty API Key. If you like, you can set up alerts through both. This step is unnecessary if you plan to enable only SMS or email alerts.
  3. In the Configuration tab, click Add alert.
  4. In the modal that appears, enter a descriptive name for your alert, select the Platform, Default Behaviors, and optionally enter a Minimum Alert Interval.
    • The Platform can be Email, SMS, or, if you provided credentials, Slack or PagerDuty. If you'd like to use more than one alert method, you must add an alert for each one.
    • The Default Behaviors can be fatal error and/or row error.
      • A fatal error is an error communicating with either a source or a destination. it's 'fatal' because the sync can't even run.
      • A row error means a problem with a particular row or rows. The sync works, but one or more rows failed.
    • Setting the Minimum Alert Interval lets you receive alerts at spaced intervals—once every hour, for instance. If you don't set this, you receive alerts every time your selected error occurs. You must enter the Minimum Alert Interval in minutes.
  5. Once you've entered your alert preferences, click Create.

Create Alert modal

You can create different alerts for different types of severity. For example, you may use PagerDuty for fatal alerts and Slack for row alerts.

Once you have default alerts set up in your workspace, you can enable alerts on syncs.

Sync alert setup

  1. Navigate to the Syncs page. Select the sync you want to enable alerting on.
  2. Open the Alerts tab in the sync settings.
  3. Under Enable alerts, you can see the alerts you set up in your workspace settings. You can override the default behavior of an alert by selecting or deselecting if it's active for a fatal error, row error, or both. You can also see a record of when the alert was last attempted.
  4. You can optionally set a row alert threshold, so you're only notified when sync errors are higher than a certain percentage of either total queried rows or synced rows. The alert threshold you set should be an integer. For example, if you want to set a threshold of 5%, enter '5'. This feature is useful when you expect a certain number of rows to fail regularly, and you don't want to be notified unless the number of errors is significant.
  5. Once you've configured your alert settings in the sync, don't forget to click Save.

Sync alert configuration

Slack alert example

If you're using Slack as your alerting tool, you can use a template to reference sync metadata.

When you do the general configuration to set up a Slack alert, you can reference sync metadata such as 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 }}"
    }
  }
]

Slack error alert configuration

You don't need to include the entire block kit object—just the array in the blocks field as shown in the preceding example. See the Slack destination documentation for more details about working with Slack's block kit.

Available sync metadata variables

  • {{ id }}
  • {{ url }}
  • {{ errorType }}
  • {{ error }}
  • {{ sync.id }}
  • {{ sync.url }}
  • {{ synced.added }}
  • {{ synced.changed }}
  • {{ synced.removed }}
  • {{ rejected.added }}
  • {{ rejected.changed }}
  • {{ rejected.removed }}
  • {{ finishedAt }}
  • {{ startedAt }}
  • {{ destination.id }}
  • {{ destination.url }}
  • {{ destination.name }}
  • {{ destination.type }}
  • {{ model.id }}
  • {{ model.url }}
  • {{ model.name }}
  • {{ model.type }}
  • {{ workspace.id }}
  • {{ workspace.url }}
  • {{ workspace.slug }}

    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?

    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

OverviewSetupGeneral configurationSync alert setupSlack alert exampleAvailable sync metadata variables

Was this page helpful?