Marketing

SparkPost

8min

With the SparkPost app in , you can send an email or monitor changes in your SparkPost account.

Requirements

To use the SparkPost app in , you must have a SparkPost account.

Connect SparkPost and

To get started, you must first create a connection between SparkPost and , allowing the two services to communicate.

To create the connection, you need to:

Obtain your API key in Sparkpost

Before you create the connection in , you should first obtain an API key in your SparkPost account.

To obtain the API key:

1

Log in to your SparkPost account.

2

Click Configuration > API Keys > Create API Key.

3

Enter a name for the API Key, select the permissions, and click Create API Key.

4

Copy the API key value and store it in a safe place.

You'll use this value in the API key connection field in .

Create the connection in

Once you have your SparkPost API key, you're ready to create the connection in .

To create the connection:

1

Log in to your account, add an {app name} module to your , and click Create a connection.

If you add a module with an ​instant​ tag, click ​Create a webhook​​, then ​Create a connection​​.

2

Optional: In the ​​Connection name​​ field, enter a name for the connection.

3

In the Region field, select the region of the organization.

4

In the API key field, enter the API key you copied from your SparkPost account.

5

Click Save.

6

If prompted, authenticate your account and confirm access.

You've successfully created the connection and can now use the SparkPost app in your . If you want to make changes to your connection in the future, follow the steps here.

Set up a SparkPost webhook

The SparkPost app has instant moduleswebhooks that watch for certain changes in SparkPost and immediately start your when those changes happen. To use these modules, you must set up the webhook in your SparkPost account.

To set up the webhook:

1

Add a SparkPost instant​ module to your and click Create a webhook​​.

2

Optional: Enter a name for the webhook in the ​Webhook name​​ field.

3

In the ​Connection​​ field, select a connection for the webhook.

If you haven't created a SparkPost connection yet, refer to the Connect Sparkpost and Make section above.

4

Click ​Save​ > ​Copy address to clipboard​​. You'll paste this address in your SparkPost account.

5

Log in to your SparkPost account.

6

From the left menu, click Configuration > Webhooks.

7

Click Create Webhook.

Your webhook is now set up. When the selected change occurs in SparkPost, will immediately be notified and start your .

SparkPost modules

After connecting to the SparkPost app, you can use the following types of modules to build your .

SparkPost resources