Webhooks - Using Webhooks to transfer data from Outgrow to your CRM

Use Outgrow quizzes and calculators which are designed for conversion and engagement and push the leads you have collected straight to a compatible web app or URL as soon as it’s submitted.

What is a webhook?

In general terms, a webhook is simply a notification sent over the web, which is triggered automatically whenever a specific event occurs.

In this case, the event is a new lead on Outgrow's calculator or quiz. Whenever a new lead is submitted, a notification containing the response data is immediately sent to your chosen destination — the Webhook URL which you set in the configuration panel.

Outgrow webhook notifications are sent via HTTP POST request, and the request body (containing the response data) is in JSON format.

Here's what you will need to get started

A. An Outgrow account (Freelancer and Essential plans do not include Webhook, Business and Enterprise plans include access to Webhooks through which users can send the lead data from Outgrow to any compatible URL)

B. An Endpoint (URL, where you want to send the data).

Note: If you need to generate a test URL you can do this using RequestBin or Mockbin.

What are the steps involved in configuring Webhooks

Follow two simple steps to start sending the leads you collect on Outgrow to an Endpoint using Webhooks

A. Configure your Webhook
B. Test connection

Configure

1. To access Webhooks, navigate to the Builder >Configure>Integration on your Outgrow calculator or quiz. Select Webhooks from the secondary navigation as shown in the illustration below.

2. Enter a Webhook URL. (This is the endpoint which we will make HTTP POST requests to).

3. You can add URL endpoint which requires authentication as well using Basic Authentication.

4. In case you want to test the payload delivery, you can create a test End Point URL here. Once you add the URL you can test the payload delivery.

In Outgrow this is how you will be able to see if the payload delivery was successful or not.

This is how successful payload delivery will look like at the specified endpoint in your CRM.

5. Hit Send test JSON and enable. If test is successful Status code 200 will be returned.

Test requests and responses will be shown on the screen as well. Once the Webhook is tested and saved, the leads from your Outgrow calculator and quizzes will start flowing to the endpoint as soon as they get created.

Important Update while using Webhooks By Zapier

In case you are using Webhooks by Zapier for transferring data that you collect using Outgrow, and you opt to duplicate the quizzes in your account, here is how you can configure Webhooks in your Outgrow account:

Scenario 1: Every time you duplicate a quiz, you will be required to set up the Webhook connection. In case you use the same structure in all the quizzes related to the number of questions, fields used in the lead form, etc, then you can use a single webhook. For this, you can configure the Global Webhook in your Outgrow account under the Settings tab.

Scenario 2: In case you have a different structure for each quiz, then for each quiz you will have a different webhook URL. You can create a new zap for each quiz, which will allow you to generate a unique webhook URL for each duplicate quiz. You can navigate to the Integration section under the Configure tab for each Outgrow content and can set up a separate webhook in this section. Here is a screenshot for your reference.

NOTE: While configuring the zap in Zapier, we recommend that you submit a fresh test lead and fetch data for this lead.

FAQs

Q1 What is a Webhook?

Ans: Webhook can be used to get data in real-time from Outgrow to your application's custom endpoint. You can receive data on Leads/Visits from Outgrow and use it as per your use-case.

Q2. What events are supported by Outgrow?

Ans: Outgrow support two types of events-

Leads: When your lead generation form is filled, an event is triggered from Outgrow to your endpoint. The trigger also depends on the delay configured on the lead generation form if it is placed on the welcome screen.

Visits: In this case, an event of the visitor is triggered for each action. So you will receive the first event when someone lands on the calculator, and then every time a question is answered. The payload from Outgrow has a visitor ID that can be used to update the data for a single visitor.

Q3. What is the best way to test Webhook on Outgrow ?

Ans: The best way to test Webhook is to go to this URL- https://webhook.site/

Now copy the unique URL, place the URL on Outgrow Webhook section and turn the leads or visits On/Off as per your use case. Now try to add a lead to your live content piece and you will receive the event data to the above site. You can analyze the data before handling it in your application.

Note: You should publish the changes before testing to make sure everything is configured properly.

Q4. Can I pass data to the URL e.g. example.com/abc/email={email} ?

Ans: No, Outgrow does not support interpolation to the Webhook endpoint. A POST request is sent to your endpoint and the body contains all the data your content piece has generated.

Q5. What is the status code you send to my endpoint?

Ans: No status code is sent, however, a POST request is sent to your endpoint and seeks a status code return by your application, the 20X code is considered a success.

Feel free to reach out to us in case you have any questions at [email protected], and we will be glad to assist you further.

👍

Tip

For rapid testing and development purposes, you can use Pipedream to develop a workflow using the Outgrow webhook event provided above as a trigger. You can learn more about it here