Skip to main content

Supported syncing

For more information about sync modes, refer to the sync modes docs.

Connect to User Interviews

Go to the Destinations overview page and click the Add destination button. Select User Interviews and click Continue. You can then authenticate Hightouch to User Interviews by entering the following required fields into Hightouch:
  • API key: The User Interviews API key to authenticate requests. See obtaining an API key for information on how to get your API key.
  • Environment: Sandbox or Production.

Sync configuration

Once you’ve set up your User Interviews destination and have a model to pull data from, you can set up your sync configuration to begin syncing data. Go to the Syncs overview page and click the Add sync button to begin. Then, select the relevant model and the User Interviews destination you want to sync to.

Syncing participants

Update existing participants’ fields and characeristics, insert new participants, or do both with upsert mode.

Record matching

To match rows from your model to participant in User Interviews, you need to select the model column that contains values that match the particpants’ email field. Refer to the record matching docs for more information.
In Insert mode, User Interviews automatically generates an identifier for every new record synced, so there is no need to match an existing record.

Field mapping

Hightouch lets you sync participant fields via field mapping. You can map data from any of your model columns to default participant fields and characteristics. Ensure your model columns data types match the data types of the fields you want to sync to.

Delete behavior

The delete behavior you select dictates what to do when a row no longer appears in your model’s query results. You have the following options:
Delete is only available for Upsert mode and Clear is available for Upsert and Update mode.

Split retries

User Interviews counts all participants in a batch as rejected if the request contains a single invalid participant. To pinpoint which participants are getting rejected with which errors and reduce the number of valid participants that get retried, you can enable split retries.

Tips and troubleshooting

To see the exact API requests and responses from each sync run, use the live debugger. To get notified by Slack, PagerDuty, SMS, or email when a sync fails, set up sync alerts. If you run into an issue this page doesn’t cover, .
Last modified on June 6, 2023