SparkPost - Email

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

2d554a7-Sparkpost.png

 

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

Set up integration

There are two steps to Blueshift integration with SparkPost:

  1. Let Blueshift access your SparkPost account
  2. Add a SparkPost adapter in Blueshift

You can directly go to the second step if you think that Blueshift can access the configuration of your SparkPost account to send emails.

Let Blueshift access your SparkPost account

To enable access for Blueshift:

  1. Create an API Key in your SparkPost account.
  2. Set up a sending domain
  3. Set up a bounce domain
  4. Create event callback in SparkPost

Create an API key in your SparkPost account

Perform the following steps to create an API key:

  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. skitch4.png

  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.

Perform the following steps to 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: skitch3.png

  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.  

sparkpost_api_key.png

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 above.

Perform the following steps to set up a sub-domain:

  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. skitch.png
  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.  Perform the following steps to set up a bounce domain. 

  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. skitch8.png
  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:

  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. 
    skitch7.png
  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.  

Add a SparkPost adapter in Blueshift

Perform the following steps to add a SparkPost adapter:

  1. In the Blueshift app, click Settings > Channels.
    select_channels.png
  2. On the Setup Channels page, select Sparkpost under Email.
  3. On the SparkPost adapter page of the Blueshift app, click +ADD ADAPTER and provide the following details:
    sparkpost_setup_2.png

    Alias name

    Specify an alias for the adapter. This is for identification purpose only. 

    Enable sink testing

    Enable this option to test email sends. If this is enabled, emails are sent to SparkPost but not delivered to users. 

    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 user can reply. 

    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 sending domain's hostname. You can find it under the CNAME DNS setting in SparkPost. 

  4. Click Save.

 

 
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request