Stitch Documentation
has moved!

Please update your bookmarks to https://www.stitchdata.com/docs

If you're not automatically redirected after 5 seconds, click here.

Setting Up Stitch Incoming Webhooks

We’re currently doing some private testing on our Incoming Webhooks integration. Want to be a part of it? Get in touch with us.

Webhooks are a simple, flexible way to keep everyone in the loop. With Stitch’s Incoming Webhooks integration, you have the ability to quickly and easily integrate with dozens of services that use webhook APIs.

To use Stitch Incoming Webhooks, you’ll need to:

  1. Add Incoming Webhooks as a Stitch data source
  2. Define the data’s Primary Key
  3. Generate a Stitch webhook URL
  4. Set up webhooks in your provider’s app

Adding Webhooks as a Stitch Data Source

  1. From the Stitch Dashboard page, click the Add an Integration button.
  2. Click the Webhooks icon.
  3. 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 data warehouse.

    For example, the name “Stitch Webhooks” would create a schema called stitch_webhooks in the data warehouse.

Defining the Primary Key

Next, you’ll define the Primary Key for the data that your Incoming Webhook integration will send to your data warehouse. A Primary Key is a field that’s used to uniquely identify each message in the webhook data. Primary Keys must:

  • Uniquely identify each message in the webhook data
  • Be top-level fields
  • Have field names with 50 or less characters

In the Primary Key field, enter the name of the field you want to use as a Primary Key. Note that this field isn’t required, but if left blank Stitch will auto-generate a Primary Key instead.

Replication & Primary Keys

Defining a Primary Key for Incoming Webhooks is optional, but before you skip this step, note that the Incremental Replication Method Stitch uses will depend on whether one is provided:

  • If a Primary Key is provided, replication to webhooks data will take place via an upsert. This means that existing rows can be updated.
  • If a Primary Key is NOT provided, replication will be append-only. Additionally, a Primary Key field called _sdc_primary_key will be automatically generated. This is because Stitch requires Primary Keys to replicate data and prevent duplication.

Additionally, we don't recommend changing a Primary Key once the integration has been set up and data has replicated. This could result in fields not being updated properly.


Click Save Integration to continue.

Generating a Stitch Webhook URL

Once Stitch has successfully saved and created the webhook integration, you’ll be redirected to a page that displays your incoming 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.

Setting Up Webhooks in Your Provider’s App

Depending on the provider you’re using, the steps for implementing webhooks may differ. We recommend checking out your provider’s documentation for instructions and reaching out to their support team if necessary.

Webhooks Data in Your Data Warehouse 

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 the integration) of your data warehouse.

The schema of an Incoming Webhooks table will contain two “types” of columns: columns used by Stitch (prepended with _sdc) and the columns sent by the provider’s webhook API.

Aside from the Stitch columns, the schema of this table will depend entirely on the provider of the webhook API. For example: if the webhook API you integrate with only contains id, event, and value fields, these are the only fields that will be created in the data table.

With the exception of the _sdc fields and a Primary Key if one isn’t provided, Stitch does not augment Incoming Webhooks data nor does it have any control over the fields sent by the webhook provider.

Was this article helpful?
0 out of 0 found this helpful

Comments

Questions or suggestions? If something in our documentation is unclear, let us know in the comments!