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.

Getting Started with 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.

Stitch’s Incoming Webhooks integration provides a simple and flexible method to integrate dozens of webhook APIs with Stitch. If Stitch doesn’t have a native integration for the webhook you want to integrate, then Stitch webhooks is your best bet. Webhooks are handy for anything that requires a notification and follow-up response, including:

  • Email events, such as bounces or spam
  • Incoming support requests
  • Incoming leads from a marketing website
  • And so on!

How Stitch Uses Webhooks

If you’ve never used a webhook before and this topic still seems a little abstract, allow us to give you an example of how Stitch uses webhooks for many of its operations.

Every time one of the following events occur, we’re notified. This could be just a simple alert or something more detailed that includes actual data and a message:

  • A new Stitch account is created or a customer changes their plan tier
  • A new NPS (Net Promoter Score) response is received
  • A customer submits an integration suggestion from our website or in the Stitch app

Integrable Webhook Services

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. Some notable services include:

Requirements for Using Stitch Incoming Webhooks

To use Stitch Incoming Webhooks, you must have a Stitch account.

In addition, the Stitch Incoming Webhooks integration can be used with any webhook API that meets the following requirements:

  • The data sent by the webhook API must come to Stitch in JSON format. This is currently the only format Stitch supports.
  • The payload (or delivery) of the data must come via a POST request.
  • The request body must be less than 4MB

You can determine if the webhook API you want to use meets the above criteria by checking out that provider's webhook API documentation.

Setting Up Incoming Webhooks

If you’ve determined that the webhook API you want to use is compatible with Stitch Incoming Webhooks, there are two steps to getting the data flowing:

  1. Generate a Stitch webhook URL
  2. Complete the setup in your provider’s app

Generating a Stitch Webhook URL

To add Stitch Incoming Webhooks as an integration in your Stitch account, refer to the Setting Up Stitch Webhooks article.

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.

However: you can find setup articles in our docs for a few of the most popular integrations that Stitch webhooks is compatible with, such as:

Webhook Data

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.

Troubleshooting

If you’re encountering issues with your Stitch Webhooks integration or you have questions that weren’t covered in this guide, check out the Stitch Webhooks FAQ.

If your question still hasn’t been answered, please get in touch with us.

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!