🔌Connect Sparkpost API
Watch our SparkPost API introduction video then read through our easy to follow documentation with more details below:
Unlike SMTP Relay, API integration must be customized for each ESP. If you are a customer and want an API integration for your favorite ESP, please open a support ticket.
API integrations are bidirectional
To track real-time delivery progress natively in your platform including bounce and complaint rates, use an API implementation such as Mailgun, Sparkpost, or Amazon SES.
Velocity MTA, which comes free with your platform, also tracks real-time delivery over your own IP Addresses.
While logged in to the backend as administrator, click the connect menu, select SparkPost API, then click add SparkPost account.
Name
Give your API connection an internal name. This will only be seen by you and is for management purposes only.
Create an API Key
Create an API Key in SparkPost and copy it into your platform configuration.
Leave 'Allowed IPs' blank, unless you know what you're doing.
Copy your API Key from SparkPost and paste it into your emaildelivery.com SparkPost API configuration.
Adding a sending domain to SparkPost
Before you can use your sending domain through the SparkPost API, you must add your domain to SparkPost and verify you're the owner.
Enter a base domain or subdomain
Most mailbox providers such as Gmail recommend using a subdomain, however, this decision is based on your own preferences and goals. Using 'sp' or 'sparkpost' is a common subdomain seen with SparkPost customers.
Domain Alignment
You'll receive a popup window after continuing. We recommend selecting 'no' on strict alignment.
Verify ownership by adding DKIM authentication
Follow SparkPost's instruction for adding DKIM verification records to your DNS provider.
SparkPost may need a moment to detect the changes you've made to your domain configuration. If it doesn't verify you right away try again in 1-2 minutes.
White-label tracking links
Unless you change your link domain, your admin_url domain will be used for your tracking links in your email messages. You can add a custom link to automatically match your domain branding for mail sent through this API connection. No further action is required beyond this step.
Make sure you point a DNS A record at your platform IP Address for your tracking link or it will not work.
Next Steps
Return to the getting ready to send page and follow the instructions to start using your newly configured Mailgun API connection.
Last updated
