Introduction to Webhooks
Groundhogg provides webhooks using which you can communicate with other software or instance or a Groundhogg located on another website.
Groundhogg webhooks are included in the advanced Feature plugin. You can view a working example of the webhook in Groundhogg's office hours ( click-me ).
There are two types of webhook.
- webhook (Action)
- Webhook Listener (Benchmark)
The Webhook step allows you to communicate with other software tools via HTTP methods.
Webhooks can only be created through the funnel builder.
To create a new Webhook add a new step to the funnel and select the Webhook icon from the Actions tab.
Once the webhook step has been added to the funnel you will see this configuration screen.
URL: Enter the target URL of your webhook here. You can test the webhook tool by using http://webhook.site/
HEADERS (optional): Add any authentication information required by the target platform.
PARAMS (optional): Add any POST information required by the target. For example the email address of the contact.
To pass contact information to the target add Params with key-value pairs. For example, passing first, last and email would look like this.
If your webhook target expects a JSON request, then you can optionally choose to send the request as a JSON payload.
To test your webhook with contact data, hover over the URL section and click Send Test. You will be able to see send test action once you move your mouse next to the URL field.
Webhook Listener (Benchmark)
The webhook listener is an important part of the webhook. Using webhook listener you can send information to groundhogg.
It's a benchmark so it uses to start an automation flow in the funnel.
You can configure this step by setting the test data to the step and mapping data with the appropriate field.
Once the step is configured successfully you will be able to send data to groundhogg.