Marketing

SparkPost

9min

The SparkPost modules allow you to track, create, update and delete a customer event and customers in your SparkPost account.
Getting Started with SparkPost
Prerequisites
A SparkPost account
In order to use SparkPost with Make, it is necessary to have a SparkPost account. If you do not have one, you can create a SparkPost account at app.sparkpost.com/join.
Note
The module dialog fields that are displayed in bold (in the Make Make, not in this documentation article) are mandatory!
Connecting SparkPost to Make
To connect your SparkPost account to Make you need to obtain the API Key from your SparkPost account and insert it in the Create a connection dialog in the Make module.
Log in to your SparkPost account.
Click Configuration > API Keys > Create API Key.
Enter a name for the API Key, select the permissions, and click Create API Key.
61f27b3ebec53.png
﻿
Copy the API Key to your clipboard.
61f27b40409bf.png
﻿
Go to Make and open the SparkPost module's Create a connection dialog.
61f27b419d671.gif
﻿
In the Connection name field, enter a name for the connection.
In the Region field, select the region of the organization:
In the API Key field, enter the API key copied in step 4 and click Continue.
The connection has been established.
Triggers
﻿Watch New Events﻿
Triggers when a new event is processed.
﻿
﻿
Webhook Name
Enter a name for the webhook.
Connection
﻿Establish a connection to your SparkPost account.
See the Connecting to SparkPost Webhook using Make to add the webhook in your SparkPost account.
Actions
﻿Send an Email﻿
Sends an email with your SparkPost.com account. You will need an API key with at least the "Transmissions: Read/Write" permission.
﻿
﻿
Connection
﻿Establish a connection to your SparkPost account.
From
Enter the email address from which you are sending the email.
Subject
Enter the subject line of the email.
Text
Enter the email body message.
Recipient
Add the email addresses of the recipients.
﻿Make an API Call﻿
Performs an arbitrary authorized API call.
﻿
﻿
Connection
﻿Establish a connection to your SparkPost account.
Region
﻿
URL
﻿
Method
﻿
Headers
Enter the desired request headers. You don't have to add authorization headers; we already did that for you.
Query String
Enter the request query string.
Body
Enter the body content for your API call.
European Union
Others
Select your region:
Note
For the list of available endpoints, refer to the SparkPost API Documentation.
Enter a path relative to https://api.sparkpost.com/api. For example: /v1/transmissions
to delete an entry.
DELETE
to make a partial entry update.
PATCH
to update/replace an existing entry.
PUT
to create a new entry.
POST
to retrieve information for an entry.
GET
Select the HTTP method you want to use:
﻿Example of Use - Get IP Pools﻿
The following API call returns all IP Pools from your SparkPost account:
URL:
/v1/ip-pools
Method:
GET
61f27b446c62a.png
﻿
Matches of the search can be found in the module's Output under Bundle > Body > results.
In our example, 2 IP pools are returned:
61f27b457c1eb.png
﻿
Connecting to a SparkPost Webhook using Make
Open the Watch Events module, enter the details as mentioned in the Watch New Events, and copy the address to your clipboard.
61f27b4687925.png
﻿
Log in to your SparkPost account. From the left menu, click Configuration > Webhooks.
61f27b47a74f5.gif
﻿
Click Create Webhook.
61f27b4a1cf89.png
﻿
The webhook is successfully created.


Webhook Name	Enter a name for the webhook.
Connection	Establish a connection to your SparkPost account.


Connection	Establish a connection to your SparkPost account.
From	Enter the email address from which you are sending the email.
Subject	Enter the subject line of the email.
Text	Enter the email body message.
Recipient	Add the email addresses of the recipients.


Connection	Establish a connection to your SparkPost account.
Region
URL
Method
Headers	Enter the desired request headers. You don't have to add authorization headers; we already did that for you.
Query String	Enter the request query string.
Body	Enter the body content for your API call.