Knock lets you send and manage notifications across email, push, SMS, and in-app from one API—without building the infrastructure yourself.
Supported syncing
| Type | Description | Supported Sync Modes | API Reference |
|---|---|---|---|
| Users | Sync data from any source to Knock users | Upsert | Users docs |
| Objects | Sync data from any source to Knock objects | Upsert | Objects docs |
| Audiences | Sync data from any source to Knock audiences | Add, Remove | Audiences docs |
For more information about sync modes, refer to the sync modes docs.
Connect to Knock
Go to the Destinations overview page and click the Add destination button. Select Knock and click Continue. You can then authenticate Hightouch to Knock.
Enter the following fields into Hightouch:
- Secret API key: You can find this in the Knock dashboard under
API keys. - (Optional) Service token: This is only required if you plan to sync audiences. You can find this in the Knock dashboard under
Service tokens.
Sync configuration
Once you've set up your Knock 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 Knock destination you want to sync to.
Syncing users
Sync data from any source to Knock users.
Record matching
To match rows from your model to users in Knock, you need to select the model column that contains values that match the ID field. Refer to the record matching docs for more information.
Field mapping
Hightouch lets you sync user fields via field mapping. You can map data from any of your model columns to default and custom user fields. If you send data for a custom field that doesn't exist, Hightouch adds the field. Ensure your model's columns have the same data types as 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:
| Behavior | Description |
|---|---|
| Do nothing | Keep the user in Knock with all its synced fields |
| Delete | Delete the synced users from Knock |
Syncing objects
Sync data from any source to Knock objects.
Record matching
To match rows from your model to objects in Knock, you need to select the model column that contains values that match the ID field. Refer to the record matching docs for more information. You can also optionally map the following fields:
- Phone number
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:
| Behavior | Description |
|---|---|
| Do nothing | Keep the object in Knock with all its synced fields |
| Delete | Delete the synced objects from Knock |
Syncing audiences
Sync data from any source to Knock audiences.
Record matching
To match rows from your model to audiences in Knock, you need to select the model column that contains values that match the ID field. Refer to the record matching docs for more information.
Field mapping
Hightouch lets you sync audience fields via field mapping. You can map data from any of your model columns to the default audience fields. Ensure your model's columns have the same data types as the fields you want to sync to.
Tips and troubleshooting
Common errors
To date, our customers haven't experienced any errors while using this destination. If you run into any issues, please don't hesitate to . We're here to help.
Live debugger
Hightouch provides complete visibility into the API calls made during each of your sync runs. We recommend reading our article on debugging tips and tricks to learn more.
Sync alerts
Hightouch can alert you of sync issues via Slack, PagerDuty, SMS, or email. For details, please visit our article on alerting.