Integrating SparkPost

1. Create API Key

Open  https://app.sparkpost.com/account/api-keys and click Create API Key. Give the key a unique API Key Name and set API Permissions to All.

The key will be created and displayed on screen. Copy it down as you'll need it for your  Campaign Refinery setup.

Open  https://app.campaignrefinery.com/settings/eds and click + Email Service before selecting Sparkpost from the drop-down menu. Give your service a unique name and paste your API key into the API Key field. When you save, Campaign Refinery will set up Webhooks for you.

2. Tracking and Sending Domains

Sparkpost will require you to have your own domain registered, and access to DNS configuration for the domain. Pick a subdomain dedicated to Sparkpost, even if you don't have it set up yet, as long as it's unique to Sparkpost and not currently in use.

  • Tracking Domain

Open  https://app.sparkpost.com/account/tracking-domains/create and enter a subdomain of your main domain, specifically for click tracking. For example, if your main domain is yourdomain.com and you plan on using sp.yourdomain.com for Sparkpost, enter click.sp.yourdomain.com in the Domain Name field. Follow the instructions to verify the CNAME through your domain registrar.

  • Sending Domain

Open  https://app.sparkpost.com/account/sending-domains and click on the Add a Domain button. Enter your chosen subdomain (for example sp.yourdomain.com).

Follow the instructions on the page to add TXT and CNAME records as indicated. Sparkpost provide help links for a variety of service providers. You will need to configure both of these for  Campaign Refinery to track your campaigns effectively.

Under Select a Tracking Domain, select the tracking domain created above. Note that your tracking domain will only appear in the drop-down list once verified.

3. Webhooks

Campaign Refinery will normally set these up for you automatically once you enter your API key. If it does not, you can set the webhooks up manually by following these steps.

Open  https://app.campaignrefinery.com/settings/eds again, and find the new Sparkpost service you set up in Step 1 above. At the top of the page, look out for a block similar to the following and copy the URL supplied.

Open  https://app.sparkpost.com/webhooks and click Create Webhook. Give the webhook a unique name, and paste the URL into the Target field. Under Events, select All, and under Authentication select None.

Click Create Webhook to save your changes.