Incoming and outgoing webhooks for Watermelon

A webhook allows you to exchange real-time information between your chatbot and external applications. In this article, we'll explain how to get started with webhooks.

What are webhooks?

A webhook is also called an HTTP push or a web callback. A webhook actually builds a bridge between two programs and allows for the automatic exchange of real-time information. In this case: between the chatbot and external applications.

How do I get started with webhooks?

First of all, it's important to think carefully about what information you want to see, and from which system. For example, do you want to retrieve the order status from your CRM system? Then think carefully about what data the chatbot needs to retrieve to be able to show this. Think of an order number and/or an e-mail address.

Before you can start using webhooks, it's important that you create the right free fields in the Watermelon platform. First, a free field that causes the "trigger" to retrieve the data. When this field is filled in (e.g. "Zipcode"), the information will be retrieved from the external system. Secondly, you need a free field, which can then display the retrieved information.

Not sure how to create free fields? In this article, we will explain how to do it!

Please note: every application has a security policy regarding the retrieval of data. It is, therefore, possible that several free fields are needed as a "trigger".

How do I create a webhook?

To create a webhook, you first need to create an API key in the Watermelon platform. A full explanation of how to do this can be found here.

To continue building the webhook, you need to be able to program. Discuss the possibilities with your (external) developer.

The full API documentation for creating a webhook can be found here. Send this documentation, including the API and Secret key to your developer.

When your (external) developer has created the webhook, you can use the free fields in your dialogue builder. How to do this is explained in this article.

Help, I don't like the layout of the retrieved information

The chatbot shows the retrieved data as it is retrieved from the external system. It may be that this does not have a nice layout. Your developer can decide how this data should be laid out. So ask your developer to change this!