SparkPost - Email

SparkPost is the world’s fastest-growing email delivery service. 

Tracked events

With SparkPost integration, we can track the following:

• Sends
• Impressions
• Unique impressions
• Clicks
• Unique clicks
• Visits
• Orders
• Activations
• Delivered (sent and not bounced)
• Revenue
• Bounces
• Spam reports
• Unsubscribes

Note:

• You must first set up a webhook in SparkPost so that Blueshift can receive messaging events.
• Click tracking in SparkPost is disabled by default when you integrate with Blueshift. You can enable SparkPost click tracking for all emails sent outside the Blueshift platform while using Blueshift for tracking clicks on all emails sent from the Blueshift platform. To take advantage of click tracking on both platforms, reach out to your CSM or support@blueshift.com.

Prerequisites

Before you can set up integration with Blueshift, you must have your SparkPost account set up.

Complete the following settings in SparkPost before you set up integration with Blueshift:

• Create an API Key in your SparkPost account
• Create a sub account
• Set up a sending domain
• Set up a bounce domain
• Create event callback in SparkPost

You can directly set up integration with Blueshift if you think that Blueshift can access the configuration of your SparkPost account to send emails.

Create an API key in your SparkPost account

1. Request a new IP from SparkPost. (Get in touch with their support to get a new IP.)
2. On the SparkPost dashboard, click Configuration > IP Pools on the left panel and then click Create IP Pool on the right panel. The Create IP Pools page appears.

   

3. Ensure that you provide appropriate information in-place of the example values and click Create IP Pool. 

After you create the IP pool, you can see it on the IP pools page. Click on the IP pool and assign the new IP address to this pool. Once you are done, create a sub account.

Create a sub account

1. On the SparkPost dashboard, click Configuration > Subaccounts on the left-panel and then click Create Subaccount on the right panel. The Create Subaccount page appears. 
2. Create a sub-account with the option to Create API key enabled, specify a name for the API key and select the required permissions. 
   
   Here are the permissions for the API key:

   

3. Ensure that you provide appropriate information in-place of example values and click Create Subaccount.

After you click Create Subaccount, ensure that you click Copy and save the API key in a secure location. SparkPost cannot provide it if you lose it.

For more information, see Create an API key on SparkPost's documentation.

Set up a sending domain

Set up a sub-domain in SparkPost that you can use as a sender and assign it to the sub account that you created in the previous step.

To set up a sub-domain, complete the following steps:

1. In the SparkPost dashboard, click Configuration > Sending domains on the left-panel, and then click Add a Domain on the right-panel. The Add a Domain page appears.

   

2. Ensure that you provide appropriate information in-place of example values and click Add Domain. 
3. SparkPost adds this sub-domain and takes you to the page where it shows this sub-domain's configuration (you can keep a copy of this page's URL). Add the TXT and CNAME values from this page to the DNS records of your provider, and then come back to this page to verify the TXT value of this sub-domain. For more information, see Sending domain on SparkPost's documentation. 

Set up a bounce domain

Set up a bounce sub-domain in SparkPost that specifies a return path for out-of-band bounces. 

To set up a bounce domain, complete the following steps:

1. In the SparkPost dashboard, click Configuration > Sending domains on the left-panel, and then click Add a Domain on the right-panel. The Add a Domain page appears.

   

2. Ensure that you provide appropriate information in-place of example values and click Add Domain. 
3. SparkPost adds this bounce sub-domain and takes you to the page where it shows this domain's configuration (you can keep a copy of this page's URL). Add the CNAME value from this page to the DNS records of your provider, and then come back to this page to verify this sub-domain. For more information, see Bounce domains on SparkPost's documentation.

Create event call back in SparkPost

In order to get events metrics pushed into Blueshift, add a webhook callback to our platform.  Events do not show up on our platform until these are configured: Delivered, Bounced, Spam Complaint, List Unsubscribes (recorded as an Unsubscribe event).

To create a webhook in SparkPost, complete the following steps:

1. On the SparkPost dashboard, click Configuration > Webhooks on the left panel, and then click Create Webhook on the right panel. The Create Webhook page appears. 
   
   
2. Specify https://api.getblueshift.com/api/v1/sparkpost/events in the Target field, and provide an appropriate name in-place of the example name. 
3. Click Create Webhook.  

Set up integration

To set up integration, complete the following steps:

1. Sign in to the Blueshift app, and click App Hub in the left navigation menu.
2. Go to All Apps, search for, and select SparkPost.
3. You can also go to Email Apps and select SparkPost.
4. Click Configure to view all the configured adapters.
5. Click +ADAPTER to add an adapter.
6. Add a Name for the adapter.  If you have multiple adapters, the adapter name helps you to identify the integration.
7. Provide the following details for integration:

   

   Field	Description
   Enable sink testing	Enable this option to test email sends. If this is enabled, emails are sent to SparkPost but not delivered to customers.
   API Key	Provide the API key that you generate at the time of enabling access for Blueshift in SparkPost.
   From Name	Specify a name that is displayed on the From field of an email.
   From Address	Specify the sender's email address.
   Reply To Address	Specify the email address to which a customer can reply.
   BCC	Specify the email addresses of people who should receive the copy of the email that your customers receive. Use comma to provide multiple email addresses. For example: johndoe@blueshift.com,janedoe@blueshift.com,doejohn@blueshift.com By default, our platform sends a copy of the email to the email addresses that you specify. If you want to include the email addresses in the BCC field of the email, drop us an email on support@blueshift.com.
   Bounce Domain	Specify the bounce domain that you added in SparkPost. Specify the bounce domain in this format: bounces@hostname-under-CNAME-DNS-setting-in-SparkPost Adapter fails if this is not provided.
   Whitelabel host name (CNAME)	Specify the domain that will be used to mask links for tracking purposes. The domain must be setup as a CNAME record in your DNS. You can find it under the CNAME DNS setting in SparkPost. The CNAME must map to either links.getblueshift.com (US or Rest of the world) or links.eu.blueshift.com (EU region) based on your Blueshift login region. SSL is required for any link masking domains. If you are unsure which domain to setup in your DNS please contact your CSM or support@getblueshift.com. If you do not specify a value here, and you have set up Whitelabeling for your account, then the domain setup in Account Settings will be used. If you have not set up Whitelabeling for your account and you do not specify a value here, the Blueshift domain will be used for tracking.

8. Select the Bypass suppression list option to send an email to all customers who qualify for a campaign regardless of their subscription status in Blueshift and SparkPost.
9. Click Save to add the adapter.

Next steps

1. Create an Email template for your messages.
2. In your campaign journey, add an Email trigger. On the Email tab of the trigger, go to Send Settings and specify SparkPost as the App and select the adapter that you just created.