Docs
/
Contact supportLog inGet started
Platform
Integrations
Building in-app UI
API reference
CLI reference
Management API
Developer tools
Tutorials
Email
SparkPost

How to send email with SparkPost

How to send transactional email notifications to SparkPost with Knock.

Knock integrates with SparkPost to send email notifications to your users.

In this guide you'll learn how to get started sending transactional email notifications with SparkPost through Knock. We also cover provider configuration and additional data you can pass through to SparkPost.

Features

  • Attachments support
  • Delivery tracking
  • Knock link and open tracking
  • SparkPost link and open tracking
  • Per environment configuration
  • Sandbox mode

Getting started

You can create a new SparkPost channel in the dashboard under the Integrations > Channels section. From there, you'll need to configure the channel for each environment you have.

Channel configuration

The following channel settings should be configured per environment. Navigate to Integrations > Channels in your dashboard, select your SparkPost channel, then click "Manage configuration" under the environment that you'd like to configure.

Fields marked with an * are required.

Knock settings

Sandbox modeboolean
Whether to enable sandbox mode for your SparkPost channel.
Knock open trackingboolean
Whether to enable Knock email-open tracking.
Knock link trackingboolean
Whether to enable Knock link-click tracking.

Provider settings for SparkPost

API keystring*
The API key for your SparkPost account.
SparkPost regionenum*
The region that your SparkPost account is in, either US or EU.
Open trackingboolean
Whether to enable SparkPost email-open tracking.
Link trackingboolean
Whether to enable SparkPost link-click tracking.
From email addressstring | liquid*
The default sender email address (can use Liquid tags).
From namestring | liquid
The default sender name (can use Liquid tags).

When configured, these optional overrides will apply to all emails sent from this channel in the configured environment. Learn more about email channel overrides here.

Tostring | liquid
The To email address that email notifications will be sent to (can use Liquid tags). This value will override the designated recipient's email address.
Ccstring | liquid
The CC email address that email notifications will be sent to (can use Liquid tags).
Bccstring | liquid
The BCC email address that email notifications will be sent to (can use Liquid tags).
Reply-tostring | liquid
The reply-to email address that will be included on email notifications (can use Liquid tags).
Payload overridesJSON (string) | liquid
Provide a JSON object to merge into the API payload that is sent to the downstream provider.

Set optional per-environment conditions for this channel. These conditions are evaluated each time a workflow run encounters a step that uses this channel in the configured environment. If the conditions are not met, the step will be skipped.

Additional data sent

Knock sends the following attributes along with your emails:

  • metadata.knock_message_id: the ID of the message this email is associated with
  • metadata.knock_recipient_id: the Knock ID of the recipient this email is being sent to

Recipient data requirements

In order to send an email notification you'll need a valid email property set on your recipient.