SparkPost Setup Tutorial

SparkPost Vendor Connection Setup Steps


(info) Under the API Credentials section of the Ongage SparkPost vendor connection, enter as following:

  • If you're a SparkPost client:
    • For non-EU accounts, Enter: in the API Host field.
    • For EU accounts, Enter: in the API Host field.
  • If you're a SparkPost Enterprise client then please contact your SparkPost Enterprise Account Manager for the tailored API Host value you need to enter.

How To Retrieve your SparkPost API Key 

  • Login to your SpartPost account using
  • Go to Configuration > API KEYS
  • Click on the “Create API key
  • Enter a name of your choice for the API key Name, and 'Select All' API Permissions.

  • Click on "Create API Key"

  • In the next screen you will see the API Key is generated. Copy the entire API Key as it is displayed only once.

How To Setup your SparkPost Sending Domain 

The sending domains (of the from email addresses) you use in Ongage, need to be configured in your SparkPost account under the Configure Menu item in SparkPost.

See SparkPost help for full details on this topic: Create Sending Domains

Also see Verifying Domain Ownership (Under SparkPost: Getting Started with SparkPost).

These verified sending domains in SparkPost need to match the from email domains, you setup in the ESP setup for SparkPost, in your Ongage Vendor Settings → My Connections Page:

Setting Your SparkPost IP Pool in Ongage 

(info) This is an optional setting. Sparkpost provides customers the ability to buy dedicated IPs, put them into pools, and choose which IP pool to use. Here you can indicate the IP pool you want to use with this connection:

If for example you want to use 2 different IPs for different lists, then you can create multiple IP pools in Sparkpost and allocate one IP in each IP pool. And then simply setup more than one Sparkpost connection in Ongage with the same API credentials, but with different IP Pool values.

You can you create IP pools by going into Configuration > IP pools and then allocate an IP to the IP pool.

You may also want to allocate a specified sending domain to send from dedicated IP pool to make sure that the emails from Ongage connection always goes through the linked IP pool and respective domain only.

For more about this Sparkpost feature, speak to your Sparkpost account manager.

(warning) If your sending domain used in Ongage is set up as a "Subaccount" then the IP pool allocated in the Ongage connection above has to be restricted with the same sub-account.

If you want to use the same sending domain for multiple IP pools in Sparkpost, then you need to set up the domain in the Sparkpost Default account (Not in Sub-account) and then allocate separate IP pool in the respective ESP connection in Ongage.

How is the Return-Path Domain Set

  • Default: by default the domain of the Return-path is set according to the domain of from-address domain.
  • Override: The Return-path can be overwritten in the SparkPost connection settings.
    • You can either enter just a domain or a full email address.


Minimum SparkPost API Permissions

When setting up an API key in SparkPost for using in Ongage, the following API Permissions at minimum must be checked in SparkPost, in order for the Ongage SMTP connection to fully work:

  • Event Webhooks Read/Write
  • Metrics Read Only
  • Transmissions Read/Write
  • Sending Domains Read/Write

About SparkPost Sending Limits