Trigger using Webhook is highly configurable and is great for automatically enrolling contacts into your workflows when an event happens in third party tools that you use. They are a straightforward and dependable way to build custom on-the-fly integrations with the tools in your tech stack.

How it works?

Webhooks are a way that your apps or services can send information to Gist. You can think of webhooks as ways that apps can speak to and notify each other. With a webhook trigger, you can “listen” for these notifications from your other apps or services, and enrol contacts into a workflow for every notification.

For example, you can trigger a workflow when following events happen in other tools:

  • A order is paid in Shopify
  • A deal in closed in Hubspot
  • An invoice is created in a custom accounting application

How to setup this trigger?

Setting up a webhook trigger may appear complicated at first but it's actually easy and straightforward.

Step 1: Create the trigger in Gist

  • Open the workflow in your Gist workspace.
  • Add a new trigger.
  • Select "Trigger using webhook" trigger from the list.
  • Copy the HTTP endpoint by clicking the button.

Step 2: Setup webhook in the third-party tool

  • Open the third-party tool you want to enrol contacts from.
  • Navigate to its webhooks page. (You'll often find it in your app's main settings page. If you’re unable to find it, check the app's help and support documentation)
  • Create a new webhook in the app.
  • Paste the webhook URL you copied from Gist in step 1.
  • Select any options that app offers - including which data you want to send via the webhook. Make sure "email" field is present.
  • Save your changes.

That's it.

Now, whenever the event you choose for the webhook in the third-party tool occurs, the contact matching with the "email" field in Gist will get enrolled into the workflow.

Note: If no matching contact exists, Gist creates a contact with the email address and then enrols them into the workflow.

Testing the webhook trigger

To test the webhook trigger, you must first add something new to your third-party app to trigger the webhook event. For example, if you're connecting to an CRM tool such as Hubspot, you could add a new contact to Hubspot.

What is Email key?

The webhook trigger, by default, expects an "email" key to be present in the request JSON it receives.

For example:

{
  email: "john@example.com"
}

There can be other keys in this JSON and they will be ignored and not stored or processed at all.

However, in some cases, the third party tool may have the email property in a nested JSON object, for example:

{
  contact: {
    email: "john@example.com"
  }
}

In such cases, when configuring the webhook trigger, you can update the "Email key" field to let Gist know which key to look for. In the example above, you will need to enter contact.email into the "Email key" field.


Need Help?

If you have any further questions, please start a Live Chat. Just "Click" on the Chat Icon in the lower right corner to talk with our support team.

IMAGE