About the Webhook Node

The Webhook node allows you to make calls to an external API and make use of the data that you're currently tracking with your other existing integrations and products.

node3.jpg

Setting up the Webhook Node

You may require additional help from a developer, or a person with development skills and knowledge about APIs. We suggest that you reach out to a member of your development department to make sure that all the settings are correct.


Setting up the Webhook Node

1. Click Edit to set up the Webhook node.

Web1.jpg

2. Choose a http method on the http dropdown.

Web3.jpg

While the action of the HTTP method depends on the API you're using, here's a rundown of what each method generally does in most cases.

GET: Retrieve data from the path/endpoint.

POST: Create new data into the path/endpoint.

PUT: Update existing data in the path/endpoint.

DELETE: Delete data in the path/endpoint.

PATCH: Partially update data in the path/endpoint.

Please note

Currently, the webhook node will send your request as a GET parameter instead of a request body payload.

We suggest that you test your Webhook node with sites like https://webhook.site or https://requestbin.com with non-sensitive test data to make sure it's working as expected.

3. Enter the URL. This is the URL to the endpoint where the Webhook will call. The Webhook node supports static parameters.

Web4_02.jpg

4. Expand the Profile data drop-down menu and choose the Attribute (Default or Custom) or Event data you wish to send to your API.

This will identify the Profile in your system. Under Parameter, enter a parameter like email or mobile, depending on your system and your choice of Event. Make sure that you set up your system to recognise this parameter.

The Event data available corresponds with the Event data in the Listen node. For example, if your Listen node is listening for Email - Click, you can choose from the data related to this event, like the title of the link they clicked. Read more about Event data here.

If your Listen node is not listening for an Event, the Event data option will not be available in the Webhook node.

node2.jpg

5. From the Response drop-down menu, choose between a string value or a status code for the response type.

Web8.jpg

6. In Expected response, add an expected response as a string value or status code.

Web9_02.jpg

7. In Error Handling, define the behaviour of the Webhook node whenever the API response doesn't match your criteria or there is an expected error (for example, the URL is incorrect or the server doesn't respond.

Web10.jpg

Next node yes: Profiles continue to the next node.

Next node no: Profiles stay in the node.

Exit flow: Profiles exit the flow.

8. To add more settings into the Webhook node, click Add Profile Data and repeat the process described above.

node1.jpg
Did this answer your question?