ROKT Events Connector Setup Guide
This article describes how to set up the ROKT Events connector.
Connector actions
Action Name | AudienceStream | EventStream |
---|---|---|
Send Conversion | ✓ | ✓ |
API information
This connector uses the following vendor API:
- API Name: ROKT API
- API Version: 2020-05-21
- API Endpoint:
<https://api.rokt.com>
- Documentation: ROKT Event API
Batch limits
This connector uses batched requests to support high-volume data transfers to the vendor. For more information, see Batched Actions. Requests are queued until one of the following thresholds is met or the profile is published:
- Max number of requests: 100
- Max time since oldest request: 10 minutes
- Max size of requests: 1 MB
Configure settings
Navigate to the Connector Marketplace and add a new connector. For general instructions on how to add a connector, see About Connectors.
After adding the connector, configure the following settings:
- Client ID
Required: provide your App ID.
See: Generating App ID and Secret. - Client Secret
Required: provide your App Secret. - Account ID
Required: your ROKT Account ID.
Click Done when you are finished configuring the connector.
Action settings — parameters and options
Click Continue to configure the connector actions. Enter in a name for the action and then select the action type from the drop-down menu.
The following section describes how to set up parameters and options for each action.
Action — Send Conversion
Parameters
Parameter | Description |
---|---|
Event Type | (Required) Type of event. |
Event ID | An identifier used to uniquely identify an event. |
Event Time | Time of the event in UTC. |
Email passed as plain text, lowercase and without trailing spaces. | |
Email - emailsha256 (already SHA256 hashed) | SHA-256 hash of email address, already hashed. |
Email - emailsha256 (apply SHA256 hash) | SHA-256 hash of email address. Tealium will hash. |
Rokt Tracking ID | A Rokt-generated ID used to match conversion events to the originating click. |
Conversion Amount | Transaction amount |
Currency Code | Currency code |
Quantity | The quantity (integer) of item within the specific conversion. |
Conversion Type | Used to differentiate between different conversion events. |
Product Names | The name of the product(s) purchased. |
Product SKUs | The identifier of the product purchased (Note: Only accepts one SKU) |
Payment Type | The payment method used during the transaction |
Credit Сard BIN | Credit card BIN of converting payment |
Margin | Profit margin of conversion |
Transaction ID | Transaction ID, used to identify a unique transaction. |
Confirmation Reference ID | Confirmation reference ID. |
Customer First Name | Customer’s first name |
Customer First Name (already SHA256 hashed) | SHA-256 hash of first name, already hashed. |
Customer First Name (apply SHA256 hash) | SHA-256 hash of first name. Tealium to hash. |
Customer Last Name | Customer’s last name |
Customer Last Name (already SHA256 hashed) | SHA-256 hash of last name, already hashed. |
Customer Last Name (apply SHA256 hash) | SHA-256 hash of last name. Tealium to hash. |
Mobile Phone Number | Mobile phone number of converting customer. |
Mobile Phone Number (already SHA256 hashed) | SHA-256 hash of phone number, already hashed. |
Mobile Phone Number (apply SHA256 hash) | SHA-256 hash of phone number. Tealium to hash. |
Customer IP Address | Customer’s IP address |
Customer IP Address (already SHA256 hashed) | SHA-256 hash of customer’s IP address, already hashed. |
Customer IP Address (apply SHA256 hash) | SHA-256 hash of customer’s IP address. Tealium to hash. |
User Agent | Browser user agent of converting customer |
Device Type | Type of device |
Device Operating System | Device operating system |
OS Version | Operating system version |
Browser | Browser |
Browser Version | Browser version |
Customer Title | Title of the customer |
Customer Gender | Gender of the customer |
Customer Date of Birth | In the format yyyymmdd |
Customer Age | Age of the customer |
Language | Language associated with the purchase |
Unit Number | Unit number associated with address |
Address 1 | First line of street address |
Address 2 | Second line of street address |
Customer Postal Code | Customer postal code |
Customer City | Customer city |
Customer State | Customer state |
Customer Country | Customer country |
Meta Data | Non-business critical information about the event. |
This page was last updated: April 14, 2022