Search documentation...

K

Rudderstack

Sync rich customer data from your data warehouse to hundreds of SaaS tools via Rudderstack's large integration library

Setup

To find the write key for your Rudderstack destination in Hightouch:

  1. Create a new HTTP API source in Rudderstack
  2. Navigate to Source Settings > API Keys and copy the "Write Key"

Syncing

Event Types

There are two types of events that can be sent to the Rudderstack destination:

  • Track (Generic): Sends events of different names when a record is added, changed, or removed in the query results
  • Identify: Sends an identify event with related properties of the user

User / Anonymous IDs

It is required to send either the user or anonymous ID to Rudderstack in order to identify the user associated with the event.

Field Mapping

You can sync columns from your source into properties of the user (identify) or properties of the event (track).

Sending Initial Results (Track Only)

For the two "Track" event types, Hightouch allows you to choose whether to:

  • Send the initial set of results as track events
  • Or, only send the changes between the results in the subsequent syncs as track events

Checking the "Send events for initial result set" checkbox will result in a large amount of events being sent in the first sync.

Hightouch will always send the initial set of results as identify calls when in the "Identify" event type.

Event Names and Timestamps (Generic Track Only)

For the generic track mode, there are further settings that are needed to determine which event name Hightouch will send to Rudderstack for each added, changed, and removed record.

In this example, Hightouch will send Rudderstack:

  • A user signed up event when a record is added to the query results
  • A user changed subscription event when a record is changed in the query results
  • A user deleted account event when a record is removed in the query results

Hightouch allows you to send a timestamp that the event occurred for generic track events. This is useful for backfilling historical events.

Hightouch also allows you to send a message ID for each record in order to ensure that the event is deduplicated within Rudderstack in the case that the same event erroneously gets sent twice.

    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

SetupSyncingEvent TypesUser / Anonymous IDsField MappingSending Initial Results (Track Only)Event Names and Timestamps (Generic Track Only)

Was this page helpful?