Connect Reverse ETL Source to Custom Audience Private Beta

Configure a Reverse ETL source with your Custom Audience destination.

announcement

The Audiences feature is in Private Beta, where we work with early users and customers to test new features and get feedback before making them generally available.

Reach out to Customer Success if you are interested in enabling this feature for your workspace.

This guide takes you through the steps to connect a Reverse ETL source to your Custom Audience destination and configure field mappings.

success
You can connect multiple Reverse ETL sources to the Custom Audience destination.

Setup

  1. Set up and configure your Reverse ETL source.
  2. In the Overview tab of the source page, click Add destination > Create new destination. You can also select an already-configured destination here.
  3. From the list of destinations, select Custom Audience and click Continue.
  4. Configure the following settings to specify how RudderStack connects to your API:
Setting
Description
NameA unique name that identifies this destination in your workspace.

Audience delivery API configuration

Setting
Description
Enter base URLSpecify the root URL for your API (for example, https://api.example.com). All requests are sent to this URL.
Specify authenticationChoose how RudderStack authenticates with your API.

See Authentication section below for details.
Custom headersThis optional setting lets you add extra key-value headers to every request (for example, Content-Type, X-API-Version).

Authentication

Method
Description
No authenticationNone — use this for public endpoints only
Basic AuthEnter a username and password
API KeySpecify a header name (for example, X-API-Key) and API key value
Bearer TokenEnter a bearer token value

Endpoint configurations

Configure how RudderStack adds, updates, and removes audience members:

SettingWhen it runs
Add recordA user enters the audience
Update recordA member’s mapped attributes change.

tip
Tip: Set Use Add record configuration to Yes to reuse the same method, path, template, and fields as Add record.
Remove recordA user leaves the audience
Use Add record configuration

Action-specific settings

Each action’s (add/update/remove record) settings follow the same structure.

HTTP method and endpoint path

SettingDescription
HTTP methodPOST, PUT, PATCH, GET, or DELETE for this action.
Endpoint path URLPath appended to the base URL.

It supports simple interpolation with connection values, for example /audiences/{{connection.audienceId}}/members.
info
The resolved URL is the base URL plus the evaluated endpoint path.

Batch size

SettingDescriptionDefault value
Batch sizeMaximum records per HTTP request for this action. Range 150005000

Request body template

Define the JSON body sent to your API. The template follows JSONata syntax.

info
Templates are validated when you save the destination. An invalid syntax is rejected with an error that identifies the action and issue.

A sample request body template is shown below:

{
  "audience_id": $$.connection.audienceId,
  "elements": [$$.records.{
    "userIds": [
      {"idType": "SHA256_EMAIL", "idValue": sha256_email},
      {"idType": "GOOGLE_AID", "idValue": google_aid}
    ],
    "firstName": first_name,
    "lastName": last_name,
    "nested": {
      "org": "static_value"
    }
  }]
}

Global objects available at runtime

Object
Description
$$.recordsArray of records in the current batch (after field processing and hashing)
$$.connectionSync connection metadata, including audienceId

Allowed operations

  • Object and array construction
  • Path expressions ($$.records, $$.connection.audienceId)
  • Iteration with { ... } — for example, $$.records.{ "email": email, "user_id": user_id }
  • String, number, and boolean literals
  • Number() casting where needed, for example,$number($$.connection.audienceId)

Template example

A template for generic batched members is shown below:

{
   "audienceId": $$.connection.audienceId,
   "users": [$$.records.{
    "email": email,
     "user_id": user_id
  }]
}

Template fields

After you define a template, RudderStack extracts field names referenced under $$.records and lists them under Template fields. Click Refresh to re-scan the template, or Manage fields to configure each field.

Manage template fields
Field settingDescription
NameDestination-side field name used in the template
RequiredIf enabled, you must map the field to a warehouse column in the Map identifiers section
StaticIf enabled, the value is a literal you provide in the Map identifiers section
HashHash algorithm applied before the template runs. You can choose between None, SHA256, SHA512, or MD5.
Configure template fields
warning

If you rename or remove template fields after syncs exist, make sure to update mappings on each affected sync manually.

See Troubleshooting for more information.

Request preview

Use Fetch preview to build a sample HTTP request from test records.

info
Preview does not send traffic to your API.
  1. Choose how many sample records to include (for example, 1 record).
  2. Edit sample data if needed.
  3. Click Fetch preview to see the resolved method, URL, headers, and JSON body.
Fetch preview
  1. Proceed to configure the mapping settings.

Mapping settings

This section lists the settings to correctly map data from your Reverse ETL source to the Custom Audience destination.

Specify target audience

warning
Create the audience on your platform before entering these values. RudderStack does not create audiences at the destination for this integration.
Setting
Description
Audience nameSpecify the name of the audience to sync data to
Audience IDSpecify the ID of the list on your platform

Sync mode

RudderStack supports only Mirror mode for this integration.

On the first run, the full membership is sent to the platform. Later runs send only inserts, updates, and deletes.

Map identifiers

Map warehouse columns to each template field defined in the Custom Audience destination.

You can map two types of fields:

  • Warehouse fields: Dropdown of warehouse columns
  • Static fields: Specify literal values for fields configured as Static in the destination settings
Map static fields

Required destination fields appear with an asterisk (*) during mapping.

Advanced settings

SettingDescription
Automatically hash PII dataWhen set to Yes, RudderStack applies each field’s configured hash algorithm to unhashed warehouse data.

When set to No, data is treated as already hashed and hashing is skipped — even if a field has a hash type configured.

See Data hashing for more information.

Sync settings

RudderStack determines how and when to run a sync based on the sync schedule you set for your Reverse ETL connection.

Schedule typeDescription
BasicRun syncs at a given time interval and specified time (in UTC).
CRONRun syncs based on a specified CRON expression (in UTC).
ManualRun syncs manually.

Sync observability settings

SettingDescription
Retain sync logsThis setting is toggled on by default and instructs RudderStack to store the sync logs in your warehouse. You can also configure the below settings:

SettingDescription
Sync log retentionSpecify the retention period of the sync logs in your warehouse.

If you set it to 1, then RudderStack deletes any sync log older than a day (in UTC time).
Snapshot table retentionSpecify the number of snapshot tables to retain.
Retry failed recordsThis setting is toggled on by default and causes RudderStack to continually retry sending the failed records.
warning
Storing sync logs and snapshot tables may incur additional warehouse costs.

Data hashing

The Automatically hash PII data setting lets you hash your user data before sending it to your API.

  • Configure the setting to Yes if your incoming data is not pre-hashed
  • Configure this setting to No if your data is already hashed
warning

Incorrect configuration of the Automatically hash PII data setting will result in failures.

  • If the Automatically hash PII data setting is configured to Yes and your data is pre-hashed, the event will fail.
  • If the Automatically hash PII data setting is configured to No and your data is not pre-hashed, the event will fail.

Such events are rejected with a clear error message, for example:

Hashing is disabled but the value for field EMAIL appears to be unhashed. Either enable hashing or send pre-hashed data.

You will also see errors in the Events tab for cases that were previously marked as successful but resulted in no matches, helping you identify and fix data quality or configuration issues.

Troubleshooting

Issue
Resolution
Template is rejected on saveThe syntax is outside the allowlisted operations — the error message names the action and position
Unexpected payload shapeUse the Fetch preview with the same sample records and action type (INSERT, UPDATE, or DELETE) to verify the payload shape
400 errors for all recordsRequired fields are unmapped or the warehouse values are empty
Wrong audience on API sideVerify the Audience ID and $$.connection.audienceId while configuring the template
Double-hashed identifiersAutomatically hash PII data setting is set to Yes while your incoming warehouse data is pre-hashed — set this setting to No
Sync fails after destination editUpdate sync mappings if destination field names or required flags have changed.

See Template fields for more information

Questions? We're here to help.

Join the RudderStack Slack community or email us for support