Zapier feature snapshot
A high-level look at Stitch's Zapier (v1) integration, including release status, useful links, and the features supported in Stitch.
|Singer GitHub repository||
|Configurable Replication Methods||
Connecting Zapier to Stitch is a three-step process:
Zapier is incredibly useful, powerful, and flexible. Because Zapier gives you complete control over how your data is defined and sent, we’ll walk you through the setup using a Zap we use at Stitch every day.
Whenever you provide feedback to us while chatting on Intercom, we record it using a Google Form. We set up a Zap that sends new submissions to our data warehouse, where we can analyze them and determine what our top priorities for development are. Additionally, everyone is notified of a new submission via email and a notification in Slack.
Add Zapier as a Stitch data source
- Sign into your Stitch account.
On the Stitch Dashboard page, click the Add Integration button.
Click the Zapier icon.
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 Zapier” would create a schema called
stitch_zapierin the destination. Note: Schema names cannot be changed after you save the integration.
- Click Save Integration.
Generate a Zapier Webhook URL
Once Stitch has successfully saved and created the Zapier integration, you’ll be redirected to a page that displays your Zapier 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 Zapier
The last step is to setup webhooks in your Zapier account.
Zapier has detailed instructions that delve into the finer points of making a Zap, but for our purposes, we’ll keep it high-level.
In this example, we’ll demonstrate by walking you through how we set up our product feedback webhook using Zapier and Google Forms.
Define the Trigger
In this step, you’ll define the event that will trigger the webhook.
- Sign into your Zapier account.
- Click Make a Zap! at the top of the page.
- Select the appropriate app from the Choose a Trigger App page. For us, we chose Google Forms.
- Next, you’ll define the Trigger. We chose to use new responses in our spreadsheet as our trigger.
- Depending on the app you’ve selected, you may be asked to select the account you want to use. Select the appropriate account and click Continue when finished.
- If you want to test the set up before moving on, feel free to do so now.
Define the Action
Next, you’ll define the action, or what happens once the webhook has been triggered.
- Select Webhooks from the Choose a Trigger App page. It’s in the Built-in Apps section.
- On the Action page, click POST. Note that Stitch Incoming Webhooks only accepts POST requests at this time - if anything else is selected, the integration won’t work.
- Next, you’ll define the template for the Zap:
- In the URL field, paste the Stitch-generated webhook URL.
- In the Payload Type field, select JSON from the drop-down menu. Note that Stitch Incoming Webhooks only accepts data in JSON format at this time - if anything else is selected, the integration won’t work.
If you choose to, you can define data in the Data section. Note that this section is optional; if left blank then the raw data from the previous step (from the app you chose) will be used instead:
We chose to re-define our form fields here, as using the raw data from the Google Form would result in columns named like this:
gsx$clientid, which we felt wasn’t query-friendly.
- When you’re finished defining the other options for the template, click Continue.
- If you’d like to test the setup so far, do so now.
- If you want to add more steps, click the Add a step button. Otherwise, if you’re finished, click Finish.
- If your testing was successful and you’re happy with your setup, toggle the Zap to On to get the data flowing.
After you’ve successfully connected your Zapier 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 Zapier 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.
This version of Stitch’s Zapier 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
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-zapier.data] o INNER JOIN ( SELECT MAX(_sdc_sequence) AS seq, [primary-key] FROM [stitch-redshift:stitch-zapier.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.
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 Zapier) of your data warehouse.
The schema of this table will contain two “types” of columns:
- Columns used by Stitch (prepended with
- Columns sent by the provider’s webhook API
Aside from the Stitch columns, the schema of this table will depend entirely on Zapier’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 Zapier webhook URLs at a time. These URLs contain security access tokens and as such, have access to your Zapier 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:
- Click into the integration from the Stitch Dashboard page.
- Click the Settings button.
- In the Webhook URLs section, click the Generate Webhook URL button.
- A new webhook URL will display. Press the clipboard icon to copy it.
- Follow the steps in the Setting Up Webhooks in Zapier section to update the webhook URL in Zapier.
- After you’ve updated the webhook URL in Zapier, click the Revoke button next to the oldest webhook URL in Stitch. This will invalidate the token and revoke access.