SparkPost Connector Setup Guide | Server-Side Connectors |Preview of Tealium Docs

Connector Actions

Action Name	AudienceStream	EventStream
Add or Update a Suppression	✓	✓
Send Email	✓	✓

Configure Settings

Go to the Connector Marketplace and add a new connector. Read the Connector Overview article for general instructions on how to add a connector.

After adding the connector, configure the following settings:

API Endpoint
To find your SparkPost API endpoint, please see the “Endpoint” section at SparkPost’s API documentation.

Please include https:// at the beginning of your API endpoint.

API Key
For information on where to find your SparkPost API keys, visit: https://app.sparkpost.com/account/api-keys.

Action Settings - Parameters and Options

Click Next or go to the Actions tab. This is where you configure connector actions.

This section describes how to set up parameters and options for each action.

Action - Add or Update a Suppression

Parameters

Parameter	Description
Email Address	Email address of the user. For more information on this endpoint, visit: SparkPost’s documentation.
Suppression Record Type	Possible Values: `transactional` or `non_transactional`.
Description	Explanation for the suppression.

Action - Send Email

Parameters

Parameter	Description
Recipient Email Address	Valid recipient email address. Only single values allowed. For more information on this endpoint, visit: SparkPost’s documentation.
Template ID	ID of the email template to use.
Recipient Name	Name attached to the recipient email address.
Campaign ID	Name of the campaign. Maximum length: 64 bytes.
Description	Description of the transmission. Maximum length: 1024 bytes.
Substitution Data	Key-value pairs that are provided to the Sparkpost Template Engine. For more information on the Sparkpost Template Engine/Language, see: SparkPost’s documentation.
Transmission Metadata	Key-value pairs associated with a transmission (email send). Metadata is provided to the Sparkpost Template Engine. A maximum of 1000 bytes of merged metadata (Transmission Metadata + Recipient Metadata) is available with Recipient Metadata taking precedence over Transmission Metadata when there are conflicts. For more information on the Sparkpost Template Engine/Language, see: SparkPost’s documentation.
Recipient Metadata	Key-value pairs associated with a recipient. Metadata is provided to the Sparkpost Template Engine. A maximum of 1000 bytes of merged metadata (Transmission Metadata + Recipient Metadata) is available with Recipient Metadata taking precedence over Transmission Metadata when there are conflicts. For more information on the Sparkpost Template Engine/Language, see: SparkPost’s documentation.
Return Path	Email address to use for envelope FROM. The domain of the Return Path address must be a CNAME-verified sending domain. For non-enterprise accounts, the local part of the Return Path address will be overwritten by SparkPost. For Enterprise accounts, the Return Path may be any valid email address and the local part in the Return Path will not be overwritten by SparkPost.
Header To	Email address to display in the To header (instead of Recipient Email Address).
Use Draft Template	Whether to use the draft version. If this is set to `true` and no draft exists, the email will fail. Default value is false. Potential values: `true` or `false`.
Tags	Single value or array of text labels associated with a recipient. Maximum number of tags: 10 per recipient, 100 system wide. Any tags over the limits are ignored.