Search documentation...

K

Courier

Power product notifications with your warehouse data in Courier

Supported sync methods

Hightouch can sync data to Courier Profiles and List Subscriptions

Courier Profiles

Sync Modes

Hightouch supports Upsert and Update sync modes:
  • In the Upsert mode, new rows will be inserted into Courier and Profile attributes will be kept up-to-date within Courier
  • In the Update mode, Profile attributes will be kept up-to-date within Courier.

Record Matching

Database records can be matched from your source to your Courier workspace by a unique property. Profiles can be matched by a Recipient ID.

Field Mapping

You can sync columns from your source to Courier's Profile default and custom fields.

Delete Mode

You can choose what Hightouch's behavior is when records leave the query result set. The default is doing nothing, but you can also set Hightouch to delete or clear the Courier profile on record exit.

Creating a new list

In your sync configuration, you can tell Hightouch to create a new Courier list for you.
You can optionally assign a custom name to your list. If no name is provided, Hightouch will default to using your model name.

Syncing to existing list(s)

Instead of creating a new list, Hightouch can also sync recipients to existing lists that are already populated in your Courier workspace.
Suppose you want to sync to multiple existing lists but do not want to create a new sync for every list. As long as your model has a list_id column associated to a row, Hightouch can sync to multiple Courier lists in just one sync!

Getting started

If you're new to Hightouch, be sure to sign up for a free account. Your first destination is free, and Courier is a great way to get started.
Before diving into this tutorial, we also recommend reading this article on our core concepts. It's a quick overview of how Hightouch works.

Step 1: Connect to Courier

Create an API token

  1. Log in to Courier
  2. Visit your Settings page
  3. Click on the API Keys tab
  4. If you already have an API key set up, copy the Published token, otherwise click on Generate New API Key

Add Courier as a destination in Hightouch

  1. Log in to Hightouch or create a free Hightouch account
  2. Click on Destinations in the left sidebar
  3. Click on Add destination in the top right corner
  4. Select Courier in the destination catalog and click Continue to proceed
  5. Paste your API token into the API Key field and click Continue to proceed
  6. Give your destination a name and unique slug (e.g., “Courier Production” and courier-production)
  7. Click Finish to create your Courier destination!
Now that we've linked Hightouch to your Courier account, it's time to connect to build profiles and list subscriptions using the data that resides in your data warehouse.

Step 2: Connect to your data source

Hightouch sits on top of your data warehouse and can read from Snowflake, Redshift, BigQuery, Databricks, Postgres, MySQL, and many other data sources. You can even fetch data from Google Sheets and Airtable. Hightouch can help activate your data wherever it resides.
We've written dedicated guides for each supported data source. Take your pick:
If you're missing the credentials necessary to connect to your data source, try inviting your teammates to Hightouch. You can have unlimited collaborators in your workspace!

Connect to a sample database instead

Waiting for credentials to your data warehouse? No problem! You can connect to one of our sample databases to get started right away. For the rest of this tutorial, we'll use our demo Postgres database, which contains a users table with names, emails, locations, and other user attributes. This sample source is available when you log in for the first time—no setup required.
Next, we'll write a SQL query to define which profiles and list subscriptions should be synced to Courier.

Step 3: Create a model

In Hightouch, a model represents a query that filters or transforms the records in your data source. Models are used to determine exactly which records to sync between sources and destinations.
When you connect to a data warehouse, your models will probably be written in SQL. You can also import models from tools like dbt and Looker.
In this example, we'll keep it simple. Suppose you want to use Courier to send notifications only for your customers located in the city of Nashville. To accomplish this, you'll want to create a model that looks like this:
SELECT * FROM users WHERE location = 'Nashville';
  1. Click on Models in the left sidebar
  2. Click on Add model in the top right corner
  3. Select Demo Database as your source and click Continue to proceed
  4. Select SQL Editor as your modeling method
  5. Paste the SQL query from above into the editor on the left side of the page
  6. Click Preview to execute the query
  7. Click Continue to proceed
  8. Give your model a name and unique slug (e.g., "Users in Nashville" and users-in-nashville)
  9. Select id as the primary key for your model
  10. Click Finish to create your model!
We just created a model using a SQL query that filters our users table down to only those located in Nashville. Next, we'll configure our sync to add these users to Courier.

Step 4a: Create a sync to Courier Profiles

  1. Click on Syncs in the left sidebar
  2. Click on Add sync in the top right corner
  3. Select Users in Nashville as your model and click Continue to proceed
  4. Select Courier Production as your destination and click Continue to proceed
  5. Select Profile as the object you wish to update in Courier
  6. Select which update mode you want to use
  7. Identify which field from your model represents the identifier known to Courier
  8. Identify which fields from your model you want to sync to a Courier Profile
  9. Select how you want to handle records leaving your source
  10. Give a name to your segment (e.g., "My beta test")
  11. Click Continue to proceed to the last step
  12. Select Interval to tell your sync to run on a set interval
  13. Configure your sync schedule to run every 5 minutes
  14. Click Finish to create your sync!
Your Courier sync configuration would look something like this.
And your sync schedule configuration would resemble this.

Step 4b: Create a sync to Courier Lists

  1. Click on Syncs in the left sidebar
  2. Click on Add sync in the top right corner
  3. Select Users in Nashville as your model and click Continue to proceed
  4. Select Courier Production as your destination and click Continue to proceed
  5. Identify which field from your model represents the identifier known to Courier
  6. Select Create a new segment
  7. Give a name to your segment (e.g., "My beta test")
  8. Click Continue to proceed to the last step
  9. Select Interval to tell your sync to run on a set interval
  10. Configure your sync schedule to run every 5 minutes
  11. Click Finish to create your sync!
Your Courier sync configuration would look something like this.
And your sync schedule configuration would resemble this.

Troubleshooting

Common errors

To date, our customers haven't experienced any errors while using the Courier destination. (Knock on wood.)

Don't see your data in Courier?

Make sure you've configured your destination to use the correct Courier environment API key! There may be quite a few so you might've accidentally copied the wrong one. If that doesn't solve your issue, please reach out! We're happy to help.

Use the Hightouch debugger

Hightouch provides full visibility into the Courier API calls made during each of your sync runs. We recommend reading our article on debugging tips and tricks.

Set up sync alerts

Hightouch can alert you of any sync issues via Slack, PagerDuty, SMS, and/or email. For details, please visit our article on alerting.

    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

Supported sync methodsCourier ProfilesCreating a new listSyncing to existing list(s)Getting startedStep 1: Connect to CourierStep 2: Connect to your data sourceStep 3: Create a modelStep 4a: Create a sync to Courier ProfilesStep 4b: Create a sync to Courier ListsTroubleshootingCommon errorsDon't see your data in Courier?Use the Hightouch debuggerSet up sync alerts

Was this page helpful?