Rokt Cloud Mode Integration

Private Beta

Rokt cloud mode event and field reference.

3 minute read

The Rokt destination integration is currently 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’re interested in enabling this destination for your workspace.

After you have configured Rokt as a destination in RudderStack, you can send conversion events to Rokt in cloud mode. Rokt supports cloud mode only for all supported source types.

Track

Rokt supports only track calls. No other call type is supported. Configure an event mapping for each track event name you want to send.

A sample track call is shown below:

javascript

rudderanalytics.track("Order Completed", {
  orderId: "order-123",
  revenue: 49.99,
  currency: "USD",
  roktClickId: "click-123",
});

Field reference

RudderStack maps the following fields to Rokt parameters. When multiple RudderStack properties are listed, RudderStack uses the first populated property. The parameter column shows the outgoing field and its containing object; some source properties are processed before delivery rather than forwarded as fields with the same name.

RudderStack property	Rokt parameter	Description
`context.traits.email` `traits.email` `properties.email`	`user_identities.email`	Email address, converted to lowercase.
`userId`	`user_identities.customerid`	Customer ID, converted to a string.
`context.traits.firstName` `context.traits.first_name` `traits.firstName` `traits.first_name`	`user_attributes.firstname`	First name.
`context.traits.firstNameSha256` `context.traits.first_name_sha256` `traits.firstNameSha256` `traits.first_name_sha256`	`user_attributes.firstnamesha256`	SHA-256-hashed first name.
`context.traits.lastName` `context.traits.last_name` `traits.lastName` `traits.last_name`	`user_attributes.lastname`	Last name.
`context.traits.lastNameSha256` `context.traits.last_name_sha256` `traits.lastNameSha256` `traits.last_name_sha256`	`user_attributes.lastnamesha256`	SHA-256-hashed last name.
`context.traits.phone` `traits.phone`	`user_attributes.mobile`	Mobile number.
`context.traits.phoneSha256` `context.traits.phone_sha256` `traits.phoneSha256` `traits.phone_sha256`	`user_attributes.mobilesha256`	SHA-256-hashed mobile number.
`context.traits.age` `traits.age`	`user_attributes.age`	Age.
`context.traits.birthday` `context.traits.dateOfBirth` `context.traits.date_of_birth` `traits.birthday` `traits.dateOfBirth` `traits.date_of_birth`	`user_attributes.dob`	Date of birth, formatted as `YYYYMMDD` when the date is valid.
`context.traits.gender` `traits.gender`	`user_attributes.gender`	Gender.
`context.traits.address.city` `context.traits.city` `traits.address.city` `traits.city`	`user_attributes.city`	City.
`context.traits.address.state` `context.traits.state` `traits.address.state` `traits.state`	`user_attributes.state`	State.
`context.traits.address.postalCode` `context.traits.address.postal_code` `context.traits.zip` `traits.address.postalCode` `traits.address.postal_code` `traits.zip`	`user_attributes.zip`	Postal code.
`context.traits.title` `traits.title`	`user_attributes.title`	Title.
`context.locale` `context.traits.language` `traits.language`	`user_attributes.language`	Language or locale.
`properties.value` `properties.revenue`	`user_attributes.value`	User attribute value. Sent as a separate field from the conversion amount, though the same property can populate both.
`properties.predictedLtv` `properties.predicted_ltv`	`user_attributes.predictedltv`	Predicted lifetime value.
`context.userAgent` `context.user_agent`	`device_info.http_header_user_agent`	HTTP user agent.
`context.traits.iosAdvertisingId` `context.traits.ios_advertising_id` `traits.iosAdvertisingId` `traits.ios_advertising_id`	`device_info.ios_advertising_id`	iOS advertising ID, unless overridden by `context.device.advertisingId` on an Apple device.
`context.traits.androidAdvertisingId` `context.traits.android_advertising_id` `traits.androidAdvertisingId` `traits.android_advertising_id`	`device_info.android_advertising_id`	Android advertising ID, unless overridden by `context.device.advertisingId` on an Android device.
`properties.orderId` `properties.order_id` `properties.confirmationRef` `properties.confirmation_ref`	`events[].data.custom_attributes.confirmationref`	Order or confirmation reference.
`properties.amount` `properties.revenue` `properties.total` `properties.value` `properties.price`	`events[].data.custom_attributes.amount`	Conversion amount, converted to a string.
`properties.currency`	`events[].data.custom_attributes.currency`	Conversion currency.
`context.page.path` `properties.name` `name`	`events[].data.custom_attributes.screen_name`	Page path or event name.
`context.page.url` `properties.url`	`events[].data.custom_attributes.url`	Page URL.
`context.ip` `context.request_ip` `request_ip`	`ip`	IP address at the batch root.
`properties.roktClickId` `properties.rokt_click_id` `properties.rclid` `properties.rtid` `context.page.search`	`user_identities.other2` `integration_attributes["1277"].passbackconversiontrackingid`	Rokt click ID. If no click ID property is populated, RudderStack reads `rclid`, then `rtid`, from `context.page.search`.
`timestamp` `originalTimestamp` `sentAt`	`events[].data.timestamp_unixtime_ms`	RudderStack selects the first populated timestamp, validates it, then converts it to Unix milliseconds. If that value is invalid, the outgoing timestamp is omitted; RudderStack does not try later properties.
`context.device.type` `context.device.advertisingId`	`device_info.ios_advertising_id` `device_info.android_advertising_id`	The device type determines where the advertising ID is placed: iOS for Apple devices or Android for Android devices. Unsupported device types do not place this ID.

The SHA-256 trait variants let you send pre-hashed PII instead of plaintext values.

Rokt Cloud Mode Integration

Track

Field reference

Questions? Let's figure it out together.