Blueshift
Step-by-step guide to send your event data from RudderStack to Blueshift.
Last updated
Was this helpful?
Step-by-step guide to send your event data from RudderStack to Blueshift.
Last updated
Was this helpful?
Blueshift's SmartHub customer data platform helps consumer brands scale customer engagement intelligently on every channel. It enables marketers to unify their siloed data and use real-time customer insights and interactions to shape customer experiences.
RudderStack supports Blueshift as a destination to which you can seamlessly send your event data.
Find the open-source transformer code for this destination in our GitHub repo.
Before configuring Blueshift as a destination in RudderStack, verify if the source platform is supported by Blueshift by referring to the table below:
Connection Mode
Web
Mobile
Server
Device mode
-
-
-
Cloud mode
Supported
Supported
Supported
To know more about the difference between cloud mode and device mode in RudderStack, refer to the RudderStack Connection Modes guide.
Once you have confirmed that the source platform supports sending events to Blueshift, follow these steps:
From your RudderStack dashboard, add the source. Then, from the list of destinations, select Blueshift.
To successfully configure Blueshift as a destination, you will need to configure the following settings:
Event API Key: Enter the Event API Key generated for your Blueshift account. You can find it in your Blueshift dashboard by going to Account Settings > API Keys.
Users API Key: Enter the Users API Key generated for your Blueshift account. You can find it in your Blueshift dashboard by going to Account Settings > API Keys.
For more information on obtaining the Event and Users API Key, refer to the FAQ section below.
Data Center: Select the data center where you want to send the data:
Standard (default): The base URL is https://api.getblueshift.com
.
EU: The base URL is https://api.eu.getblueshift.com
.
The identify
call lets you create new or update existing customers and record the traits about them like their name, email address, etc. A sample identify
call is shown below:
It is recommended to limit the identify
calls to 50 per second.
The following table details the mapping between RudderStack and Blueshift fields:
email
email
Required
userId
customer_id
Required
event
event
Optional
phone
phone_number
Optional
firstName
firstname
Optional
lastName
lastname
Optional
gender
gender
Optional
Blueshift supports custom attributes from your site's customers. For more information on these attributes, refer to Blueshift Custom Attributes.
The track
call lets you capture user events along with the associated properties.
A sample track
call is shown below:
RudderStack maps the following e-Commerce events to the Blueshift events in the track
call before sending them over Blueshift's HTTP API.
Product Viewed
view
Product Added
add_to_cart
Order Completed
purchase
Products Searched
search
Checkout Step Viewed
checkout
Product Removed
remove_from_cart
The other generic event mappings are listed below:
Subscribe Interest
subscribe_interest
Unsubscribe Interest
unsubscribe_interest
Identify
identify
Blueshift supports custom events to track any custom user action on your site or app. For more information, refer to the Blueshift Custom Event guide.
The following table details the mapping between RudderStack and Blueshift fields:
event
event
Required
userId
customer_id
Optional
email
email
Optional
context.device.type
device_type
Optional
context.device.token
device_token
Optional
context.device.id
device_id
Optional
context.idfa
/context.device.advertisingId
device_idfa
Optional
context.idfv
/context.device.id
device_idfv
Optional
context.device.manufacturer
device_manufacturer
Optional
context.os.name
os_name
Optional
context.network.carrier
network_carrier
Optional
context.ip
/request_ip
ip
Optional
context.address.latitude
/context.location.latitude
latitude
Optional
context.address.longitude
/context.location.longitude
longitude
Optional
messageId
event_uuid
Optional
properties.cookie
cookie
Optional
The event
name is a required field and should not contain a period (.), a numeric value, or be more than 64 characters. Otherwise, RudderStack will reject the event and throw an error.
Also, RudderStack automatically converts a space in the event name to an underscore (_). So, an event name like custom events
will be converted to custom_events
before sending it to Blueshift.
Blueshift supports receiving custom attributes about your site's customers. For more information on these attributes, refer to the Blueshift Custom Attributes.
The group
call lets you associate a user with a group. For each group
call, RudderStack triggers Blueshift's event
API and sends an identify
event along with the groupId
. Blueshift then creates a group and adds the user to it.
A sample group
call is shown below:
The following table details the mapping between RudderStack and Blueshift fields:
groupId
group_id
Required
userId
customer_id
Required
email
email
Optional
context.device.type
device_type
Optional
context.device.token
device_token
Optional
context.device.id
device_id
Optional
context.idfa
/context.device.advertisingId
device_idfa
Optional
context.idfv
/context.device.id
device_idfv
Optional
context.device.manufacturer
device_manufacturer
Optional
context.os.name
os_name
Optional
context.network.carrier
network_carrier
Optional
context.ip
, request_ip
ip
Optional
context.address.latitude
, context.location.latitude
latitude
Optional
context.address.longitude
, context.location.longitude
longitude
Optional
messageId
event_uuid
Optional
Blueshift supports receiving custom attributes about your site's customers. For more information on these attributes, refer to the Blueshift Custom Attributes.
To obtain the API keys, log into the Blueshift app, go to Account Settings and then to the API keys tab. You can obtain the following API keys, based on your role:
Event API key (EVENT_API_KEY)
Users API key (USER_API_KEY) (visible only to admin users)
For queries on any of the sections covered in this guide, you can contact us or start a conversation in our Slack community.