How to send email with Sparkpost
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
- 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.
Provider configuration
API keystring*The API key for your Sparkpost account
RegionenumThe region that your sparkpost account is in, either US or EU
Open trackingbooleanShould the provider track opens on their service?
Link trackingbooleanShould the provider track link clicks on their service?
From email addressstring | liquid*The sender email address (can use Liquid tags)
From namestring | liquidThe sender name (can use Liquid tags)
Environment default settings
The following fields are optional and if set, will be applied to all email messages sent via this channel within the environment:
Reply-to addressstring | liquidThe reply-to email address (can use Liquid tags)
CC addressstring | liquidThe cc email address (can use Liquid tags)
BCC addressstring | liquidThe bcc email address (can use Liquid tags)
JSON overridesstring | liquidProvider API's parameter overrides
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 withmetadata.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.