SparkPost

SparkPost feature snapshot

A high-level look at Stitch's SparkPost (v1) integration, including release status, useful links, and the features supported in Stitch.

Connecting SparkPost

Connecting SparkPost to Stitch is a three-step process:

1. Add SparkPost as a Stitch data source
2. Generate a Webhook URL
3. Set up webhooks in SparkPost

Add SparkPost as a Stitch data source

1. Sign into your Stitch account.

2. On the Stitch Dashboard page, click the Add Integration button.

3. Click the SparkPost icon.

4. Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination.

   For example, the name “Stitch SparkPost” would create a schema called stitch_sparkpost in the destination. Note: Schema names cannot be changed after you save the integration.

5. Click Save Integration.

Generate a SparkPost Webhook URL

Once Stitch has successfully saved and created the SparkPost integration, you’ll be redirected to a page that displays your SparkPost webhook URL and token (which is blurred in the image below):

Click the Copy button to copy it.

Note that this particular URL won’t display in Stitch again once you click Continue. Think of this URL like you would your login or API credentials - keep it secret, keep it safe. You can, however, generate another URL should you need it.

Once you’ve copied your webhook URL, click Continue to wrap things up in Stitch.

Set up webhooks in SparkPost

The last step is to setup webhooks in your SparkPost account.

1. Sign into your SparkPost account.
2. Click Account in the left nav tab.
3. Click Webhooks.
4. Click the New Webhook button.
5. In the Webhook Name field, enter a name for the webhook. We recommend using a name that will tell you, at a glance, what the webhook is for.
6. In the Target URL field, paste your Stitch-generated webhook URL.
7. In the Authentication field, ensure that None is selected.

8. In the Events section, you can select the events you want to track. By default everything is selected, but to pick and choose, click Select and then use the checkboxes to select the events you want:

   

9. When finished, click Add Webhook.

Testing the Setup

To ensure everything is set up properly, you can send a test call to your Stitch webhook by clicking the Test button next to the Stitch webhook and then clicking Send Test Batch:

If you encounter a 5xx error (ex: 503 - Service Unavailable), check the Stitch Status Page to see if we’ve reported any issues.

Replication

After you’ve successfully connected your SparkPost integration, Stitch will continuously replicate your webhook data into your destination.

• Webhooks and historical data
• How data is loaded into your destination
• How to query for the latest data

Webhooks and historical data

Because SparkPost data is sent to Stitch in real-time, this means that only new records are replicated to your destination. Most webhook-based integrations don’t retain historical data due to this as-it-happens approach.

In the event that our webhook service experiences downtime, you may notice some lag between an event occurring and the data appearing in your destination.

Loading behavior

This version of Stitch’s SparkPost integration loads data in an Append-Only fashion. When data is loaded using the Append-Only behavior, records are appended to the end of the table as new rows. Existing rows in the table aren’t updated even if the source has defined Primary Keys. Multiple versions of a row can exist in a table, creating a log of how a record has changed over time. Data stored this way can provide insights and historical details about how those rows have changed over time.

Refer to the Understanding loading behavior guide for more info and examples.

Query for the latest data

If you simply want the latest version of the object - or objects, if you elected to track more than one during the setup - in the integration’s table (data), you’ll have to adjust your querying strategy to account for the append-only method of replication. This is a little different than querying records that are updated using updated_at Incremental Replication.

To do this, you can use the _sdc_sequence column and the table’s Primary Key. The _sdc_sequence is a Unix epoch (down to the millisecond) attached to the record during replication and can help determine the order of all the versions of a row.

Note: If you didn’t define a Primary Key while setting up the integration, the Primary Key for the table will be __sdc_primary_key.

If you wanted to create a snapshot of the latest version of this table, you could run a query like this:

SELECT * FROM [stitch-redshift:stitch-sparkpost.data] o
INNER JOIN (
    SELECT
        MAX(_sdc_sequence) AS seq,
        [primary-key]
    FROM [stitch-redshift:stitch-sparkpost.data]
    GROUP BY [primary-key]) oo
ON o.[primary-key] = oo.[primary-key]
AND o._sdc_sequence = oo.seq

This approach uses a subquery to get a single list of every row’s Primary Key and maximum sequence number. It then joins the original table to both the Primary Key and maximum sequence, which makes all other column values available for querying.

Schema

In v1 of the Stitch Incoming Webhooks integration, Stitch will create a single table - called data - in the webhook integration schema (this will be the name you enter in the Integration Schema field when you set up SparkPost) of your data warehouse.

The schema of this table will contain two “types” of columns:

• Columns used by Stitch (prepended with _sdc), and
• Columns sent by the provider’s webhook API

Aside from the Stitch columns, the schema of this table will depend entirely on SparkPost’s webhook API. With the exception of the _sdc fields, Stitch does not augment Incoming Webhooks data nor does it have any control over the fields sent by the webhook provider.

Webhook URLs & Security

Stitch allows you to generate up to 2 SparkPost webhook URLs at a time. These URLs contain security access tokens and as such, have access to your SparkPost account.

If you ever need to change your webhook URL, you can do so in the Integration Settings page after the integration has been created:

1. Click into the integration from the Stitch Dashboard page.
2. Click the Settings button.
3. In the Webhook URLs section, click the Generate Webhook URL button.
4. A new webhook URL will display. Press the clipboard icon to copy it.
5. Follow the steps in the Setting Up Webhooks in SparkPost section to update the webhook URL in SparkPost.
6. After you’ve updated the webhook URL in SparkPost, click the Revoke button next to the oldest webhook URL in Stitch. This will invalidate the token and revoke access.

Did this article help? If you have questions or feedback, feel free to submit a pull request with your suggestions, open an issue on GitHub, or reach out to us.