Integrating SparkPost

Capabilities

DataGrail's SparkPost integration provides the following capabilities:

Product	Capability
Request Manager	Request Types Access, Deletion, Do Not Sell/Share Identifier Categories Email Foundation Connections Transactional Mailer

Before You Start

To successfully configure this integration, please ensure you have sufficient privileges:

• DataGrail User Role: Super Admin, Connections Manager
• SparkPost User Role: Admin

Create a SparkPost API Key

1. Log in to SparkPost.
2. In the left-hand menu, select Configurations and then API Keys.
3. In the top-right, select Create API Key.
4. In the new page that opens, configure the new API key with the following information:

API Key Configuration

API Key Name: DataGrail (You can use any value)

Subaccount: leave blank

Allowed IPs: leave blank

API Permissions: Select the following permissions depending on your integration needs:

Required for All Integrations

• Account: Read
• Suppression Lists: Read/Write

Access

• Events Search: Read-only
• Recipient Lists: Read/Write

Deletion

• Data Privacy: Read/Write
• Recipient Lists: Read/Write

Do Not Sell/Share

• Data Privacy: Read/Write

Transactional Mailer

• Transmissions: Read/Write

5. Select Create API Key.
6. Copy your API Key and store it in a temporary, secure location.

Configure SparkPost as a Transactional Mailer

This configuration step is required if you are going to use the SparkPost service as your DataGrail transaction mailer.

1. Go to Configuration, then Domains and select Add a Domain.
2. Select the Sending Domain option, define a Subaccount Assignment and select Save and Continue.
3. Add the required DNS records to verify your domain.
4. Select Verify Domain.
5. Confirm that the API Key create in the previous step has the Transmissions: Read/Write permission. If not, update the API key.
6. If you want to support Bounce Domains, follow the Bounce Domain Configuration below.

Bounce Domain Configuration

• Navigate to Configuration, then Domains and select the Bounce Domains option.
• Configure and select the bounce domain to fill the Return Path:
  • The domain of the Return Path address must be a CNAME-verified sending domain. The local part of the Return Path address will be overwritten by SparkPost.
  • For Enterprise accounts, the Return Path may be any valid email address and the local part in the Return Path will not be overwritten by SparkPost.

Connect to DataGrail

1. Return to DataGrail.
2. Enter the API Key obtained from the first step.
3. Select the Account Location in the dropdown.
4. If you are using SparkPost as a Transactional Mailer and have configured Bounce Domains, enter the Return Path used above.
5. Select your desired Asynchronous Deletion Behavior.

SparkPost Deletion Behavior Configuration

Mark integration as complete when a deletion request is successfully submitted: The SparkPost Integration will be marked as "complete" as soon as the deletion request is submitted to SparkPost.

Continue processing until the deletion request is completed (default behavior): The SparkPost Integration will show a "processing" status until the SparkPost deletion is complete.

6. Select Configure Integration.

Next Steps

Now that you've successfully connected the integration, check out the following resources:

• Transactional Mailer - Deliverability Testing
• Synchronous vs. Asynchronous Integrations
• Whole Record Deletion
• Access Request Lifecycle

Troubleshooting

If you are unable to successfully connect the integration, review these common troubleshooting steps:

Ensure Required Permissions Are Granted on API Keys/Resources

DataGrail checks required permissions and scopes on API keys/resources used by each integration. If all necessary permissions are not granted, new connections will fail.

Review Required Account Types and User Roles

If users do not have the necessary permissions or the minimum required user role in the connecting system, the connection to DataGrail will fail. Additionally, connections will fail if your account type does not match the one required by the integration.

See Before You Start to review these requirements.

Technical Details

The SparkPost integration uses the V1 API:

Access Type	Synchronous
Deletion Type	Asynchronous (Whole Record)

API Documentation

Learn more about this API implementation and DataGrail functionality in our API Integration Documentation.