Blueshift has several 3rd party integrations to make it easier to send data into Blueshift, as well as to execute campaigns across different channels. For mobile data integrations, we recommend using mParticle and Segment.com.
- Google Tag Manager
- Demandware (now known as Salesforce Commerce Cloud)
Mapping of 3rd party events on Blueshift :
We map certain 3rd party events to standard events which Blueshift understands. For example, you might be having events products_ordered, products_viewed and products_added_to_cart which when passed to Blueshift will be renamed/mapped as standard events like purchase, view and add_to_cart.
Google Tag Manager helps make tag management simple, easy and reliable by allowing marketers and webmasters to deploy website tags all in one place. We've provided some examples of how to setup Blueshift events in GTM. Please do the same for all other events you would like to send to us.
- Create a new tag "Pageload" and select Custom HTML Tag as your product.
- Paste the standard Blueshift pageload tracking code in the HTML box
- Setup trigger to fire on all pages
- Create a custom HTML tag for the Identify event. You will also need to insert the values in the datalayer for customerId, email etc into the tag.
- Next add a trigger to fire this tag by editing the Triggering block on GTM.
Segment is a flexible and fast alternative to integrating Blueshift. They are a customer data hub for easily installing marketing and analytics software.
If you currently use Segment, you can integrate your data into Blueshift with a 1-click integration.
Send campaign engagement data back to Segment.com
Blueshift also supports sending campaign engagement data back into Segment.com with the use of Segment.com Sources. In order to use the sources integration, you will need a "Write key" from Segment.com and enter it in the Blueshift Account Setup dashboard. Once the key is entered ensure that you select enabled on the Blueshift Event notifications. You can find more information on this integration including schema specs from Segment.com Blueshift source documentation page.
TealiumIQ is a leading tag management solution, and one of the several easy options to integrate with Blueshift. If you are a TealiumIQ customer, simply select "add tag"from your Tealium IQ dashboard, and search for Blueshift.
You will be presented with this simple screen to configure your tag:
Ensighten is a leading tag management solution, and one of the several easy options to integrate with Blueshift. If you are an Ensighten customer, simply select “Apps”from your dashboard, and search for Blueshift.
You will be presented with this simple screen to configure your data:
mParticle is a customer data platform built specifically for apps across all devices. mParticle provides a single API to collect customer data once and connect it to any analytics, marketing, and data warehousing platform.
In order to use Blueshift with mParticle, you can follow the steps listed at mParticle's documentation site.
a. Login to mParticle - https://app.mparticle.com
b. To configure the Blueshift Event Integration, do the following:
- Select the Integration icon from the left navigation
- Select your app from the app dropdown
- Select the Blueshift tile to display the Integration Details Tab.
This provides information regarding the integration such as, type of events, User IDs, Device IDs and other information about the integration that is shared between mParticle and Blueshift
c. Click ACTIVATE A PLATFORM - There will be a tab for entering settings for each supported platform shared by the app and Blueshift
d. Enter the Blueshift specific parameters - Event API Key, User API Key
e. Toggle the Status slider to On to activate the integration
f. Click SAVE to enable event data to be forwarded from your app to Blueshift
Demandware is a leading e-Commerce Platform. Blueshift offers a Demandware cartridge to integrate your Demandware data.
SendGrid provides a cloud-based email delivery service that assists businesses with email delivery. The service manages various types of email including shipping notifications, friend requests, sign-up confirmations, and email newsletters. It also handles internet service provider (ISP) monitoring, domain keys, sender policy framework (SPF), and feedback loops.
1. Request or select IP address for Sub user
- Sub account should be created for each blueshift adapter.
- Sub Accounts/Blueshift adapters can share IPs
- Set Sub User name and password
- Select IP Address from step 1
3. Configure Sendgrid DNS
- See SendGrid DNS authentication documentation
- Configure Sending Domain authentication.
- Configure Reverse DNS
4. Add SendGrid DNS entries with your hosting provider
Each hosting provider configuration will very but will use the same SendGrid DNS entries
Verify DNS in Sendgrid
5. Associate DNS setup to subuser
- Select sub user from the parent account
Add Sending authentication
Add IP Address if not already associated
6. Log into Sendgrid Sub User
Update Settings > Mail Settings > Event Notification
Update "HTTP Post URL"
Update URL with blueshift event call back url
Update "Select Actions"
- Select all but ASM Unsubscribe actions
Save and enable Event Notification
7. Provisioning your Sendgrid API Key
- Login to your Sendgrid dashboard. If the username is a sub-account, make sure to switch to that sub account in the Sendgrid dashboard.
- Navigate to Settings > API Keys in the left menu.
- In the top right, click the “Create API Key” button.
- Give the API Key a name. Under API Key Permissions select “Restricted Access”.
- Make sure the following permissions are given
- Email Activity => Read
- Email Testing => Full
- Mail Send => Full
- Mail Settings => Full
- Sender Authentication => Full
- Suppressions => Full
- Tracking => Full
- Copy the generated API Key into the Sendgrid adapter in the Blueshift adapter.
- Verify setup was successful by performing a test send inside Blueshift with the adapter.
8. Add SendGrid to your blueshift Account
Setup Channels > Sendgrid
Alias name = Name of the adapter in campaigns
Suggestion domain associated to adapter
- API Key = API key created in previous step
- Default From name
- Can be overridden at the trigger level
- Default From address
- Can be overridden at the trigger level
- The domain MUST remain the same for DNS settings to be configured currently.
- From domain to the left to the @ sign can be anything you want.
- ie: email@example.com where xxx can be changed without affecting the configuration at the trigger level.
- Default Reply to
- Select an email address here you would like responses sent to. This can be any address you want.
- If you decide you want no replies you can either select a valid email address with a response (hosted by you) or an invalid domain. The invalid domain will return an mailbox not found error from the respective ISP.
Enable ESP engagement event callbacks
- This should not be enabled for external Sendgrid setups.
- This is for only for Blueshift owned accounts.
- Enabling will generate errors on our end if this is selected since we will not be able to access your Sendgrid instance.
Send test message from any Blueshift template
- Any error in Blueshift means domain is not validated or settings are incorrect
- If you receive the test message and your domain says firstname.lastname@example.org via example.com or via sengrid.com the sending domain authentication is not configured for the sub user in Sendgrid.
SparkPost is the world’s fastest-growing email delivery service. Our customers — including Pinterest, Twitter, CareerBuilder, LinkedIn, Salesforce, Zillow, and Comcast — send over 3 trillion messages a year, over 25% of the world’s non-spam email.
Setting up access in Sparkpost
- Request or add IP if needed.
- This can be done via the UI, Sparkpost Support or you account rep depending on your agreement with Sparkpost.
- Create IP Pool
- Assign IP to new IP Pool
- Create sub account
- API Key needs full permissions
- Metrics and read templates are not required.
- API Key needs full permissions
- A full account can be used but in most cases a sub account will be used if you are already using Sparkpost for other sending capabilities.
- Create new API key during sub account setup
- Set API Permissions.
- Assign the IP Pool you created.
- Save API key
- This is very important as this will be regenerated by Sparkpost.
- Setup Domain
- Setup Domain to be used as sender from domain.
- Setup Bounce Domain
- Assign the bounce domain to the sub account you setup.
- Setup Bounce domain - recommended setup by Sparkpost
- Add DNS with your DNS provider
- Validate DNS entries in Sparkpost
- Account/Domain Authentication is complete
Creating Event call back in Sparkpost
In order to have all events metrics pushed into Blueshift you will need to add a webhook callback to Blueshift. Events that will not show up until this is configured: Delivered, Bounced, Spam Complaint, List Unsubscribes (show up as Unsubscribe in blueshift)
- Create Webhook
- Event Call back URL: https://api.getblueshift.com/api/v1/sparkpost/events
Adding External Sparkpost setup to Blueshift
- Create new adapter under setup channel
- Add Alias name
- This will be the name that shows in the drop down when selecting which domain/IP to use.
- Add API key
- Key created in sparkpost for the new sub account
- Add Default mailbox info
- Add Default bounce domain
- Must be in the format email@example.com
- Adapter will fail if a valid bounce domain is not configured.
- White Label
- This is not required but highly recommended.
- We support white labeling at the adapter level, meaning each domain setup can have its own unique white label for links. This can not match the domain exactly. Matching will create conflict if you are adding MX records to the sub domain since we redirect traffic to Blueshift in order to track clicks.
- Confirm settings
- by sending a test message.
- Check the spam folder if this is a new domain/IP setup
- No errors - You should receive a message
- If errors check the domain(s) have been validated in Sparkpost
- Make sure bounce domain has been added.
3. SMTP Relay
Simply enter your smtp credentials and connect Blueshift with your sending provider
Send and receive global SMS, MMS, and chat messages from any app, and ensure deliverability using intelligent delivery features.
Here's how to configure the Twilio adapter in the Blueshift app.
On the Twilio SMS adapter page of the Blueshift app, provide the following details:
|Alias Name||Specify a name for the integration|
Phone number from your Twilio console.
|API Key SID||
Create an API SID and key to integrate Twilio with Blueshift from the settings page of your Twilio account.
Ensure that you save the SID and Key in a secure location since you cannot retrieve these details later.
In the above page, API secret is created as well. Provide the secret that you create above.
The account SID is available on the general settings page of the Twilio console.
|Messaging Service SID||
The messaging service SID is available on the SMS services page of the Twilio console.
|Status callback URL||
Leave this field blank.
When a user responds to an SMS with an opt-out word (such as STOP, BLOCK, CANCEL, STOPALL, UNSUBSCRIBE, QUIT, or END), we automatically unsubscribe the user from the SMS channel. Similarly, when a user responds to an SMS with an opt-in word (START, YES, UNSTOP), we automatically subscribe the user to the SMS Channel.
Automatic subscription management for the SMS channel is currently available only for Twilio. Subscribes and unsubscribes to the SMS channel are handled at a user level and we cannot attribute them to any template or campaign.
To handle such requests from your customers, ensure that:
- You select SEND AN INCOMING_MESSAGE WEBHOOK under Inbound Settings of the messaging service page of your Twilio account.
- You specify https://api.getblueshift.com/api/v1/messaging_events/a6903a6b-279e-4035-a001-7ae8426e65df in the REQUEST URL field. Ensure that you Save this configuration.
Headquartered in Silicon Valley, GupShup is the leading smart messaging platform that handles over 4 billion messages per month and has processed over 150 billion messages in total. It offers APIs for developers to build Interactive, Programmable, Omni-channel messaging bots and services as well as SDKs to enable in-app and in-web messaging.
Attentive is a personalized mobile messaging platform that helps forward-thinking companies acquire, retain, and interact with mobile audiences in a new way. Attentive provides APIs to developers to send SMSes and MMSes programmatically to subscribers of your marketing campaigns.
Branch helps companies drive seamless mobile experiences through its linking infrastructure powering thousands of today's top brands. Once you have your app integrated with the Branch SDK, you can enable the deep linking integration on Blueshift.
Follow these one-time steps to enable Blueshift+Branch integration:
a. Follow the Branch documentation to setup deep linking in Branch and enable the Blueshift integration.
b. As a one-time setup, ask your Blueshift Account Manager, to enable branch.io integration in your account. This is a one-time setup that is done during account onboarding if you are already using branch.io or can be added later on when you do the Branch SDK integration.
Note: You need to change the cname to the branch cname within the dashboard at: https://app.getblueshift.com/dashboard#/app/account/other
c. Once your integration is live, you can use Branch supported deeplinks:
In your email templates, you must add a deeplink="true" attribute to links that should treated as deep links or iOS universal links. This attribute must be present in order for the link to open the app as expected.