Sending email templates: SparkPost

To use SparkPost to start sending email templates, signup for an account and create a sending domain. You have to obtain an API key after verifying the sending domain. SparkPost provides helpful interface to guide through the process. SparkPost’s free plan should be enough to cover your initial email volume. Create templates and use template names in API requests. You can learn more about SparkPost templates here.

Note

You have to own a domain for completing SparkPost setup.

Please remember that you have to setup SPF and DKIM records for your domain to start sending emails from your domain. Otherwise, SparkPost will reject sending emails.

Here are some SparkPost resources for verifying sending domain and setting up SPF/DKIM:

You need to configure the following options in conf/notify.yaml inside the project directory:

  • Make SparkPost to be the default provider, under email
email:
  default: sparkPost

  • Now we need to configure Notify with the SparkPost API key. To do this we don’t store the key directly in the notify.yaml file. Instead, we refer to a secret value in the conf, and our actual API key in the secret.

    Under email -> providers -> sparkPost, the apiKey already refers to the secret. So we have to update the secret

$ hasura secrets update notify.sparkpost.key "<your-sparkpost-api-key>"
« previous | next »
Want to contribute or report missing content? Check out the github repo for docs.
Powered by Sphinx. Copyright © 2019 Hasura.