Create Webhook URL using Default Apps

You can register a new Webhook URL, this can be connected to an existing Plugin or can be an other webhook. As we explain before we are going to create our first webhook for the Event1. This webhook will be created using the Default plugin. Lets follow the next steps:

First we need to know how the response will be from the external server. For instances:

{
    "response":{
        "user_id": "1234",
        "event_type": "User bought something"
    }
}

Now we are ready to generate a new webhook URL by clicking on the “New Webhook URL” button.

After that, we have to select the plugin called “Default Apps” and give a name for this new webhook URL. For instance in our example we named “I love to buy Website”.

Now we need to configure some new parameters from the webhook settings:

Field name Description
Name This is the webhook name.
Webhook URL This is the webhook URL that listens all the response from an external server. This is the url that it has to be added in your server configuration.
Identifier This is the identifier of the response. This field is important because it lets the system know how to search for the incoming answer of the external server.
Status Key This is the response value that we want to check in the webhook listener in our flow. For instance, in an email can be the bounced reason.
Whitelist IPS This is the list of ips (IPv4 or IPv6) separated by comma available in the plafrom for this webhook.
Webhook sends batch response? This determines if the webhook is receiving a batch of responses
Is it for facebook? Whether this webhook is for Facebook or not

If we want to use it in a flow, first we have to create new webhook objects. Those objects will be linked to this webhook URL. To perform this we need to press on “Add a new flow object” buttons at the bottom of the above image.

Once a webhook object is created we need to edit its configuration:

App Information: This tab contains the customization of the webhook object like title, background colour, …


In this section we can configure the object properties. The following table shows in detail:

Field name Description
Webhook identifier This is the name that will be used to identify this flow object. It has to be unique.
Title This is the title that it will be shown in the Webhook object inside the Flow canvas.
Background color This is the background color of the Webhook object.
Text color This is the title color of the Webhook object.
Icon To show an icon in the Webhook object. Right size should be 128x128px.

Parameter Configuration: This tab contains the parameters to link the response with other objects in the Flow canvas. After configuring the tab “App Information”, we need to prepare the parameters from our servers. The below image shows how to configure the parameter that we want to show in the Webhook object inside the Flow canvas.

Field name Description
Webhook id value This is the path in your data record where the unique ID is saved to match the response from the webhook. Let’s suppose this is the information you are sending to the platform to your webhook URL:

{
    "response" : {
        "user_id": 1978,
        "event_type": "new",
        "name": "John Doe"
    },
    "address": "Helm St. 23",
    "date": "2016-09-12 13:00:01"
}

So the “Webhook identifier” in your webhook URL will be response.user_id and the “Status Key” will be response.event_type. What you have to fill in “Webhook Id value” is the path in your data record where the 1978 value has been stored, for example from another object, so later on it can be compared with the value received. For example. it could be @data.user.userid@.

Webhook Status This option allows you to include all the possible values that come from your server response. For instance a list of values like:
User bought something
User logged in
User asked for help
User deleted his account

The webhook Status parameter can be configured using the following fields:

Field name Description
Label of the Parameter This is the parameter title that it will be shown in the Webhook object.
Name of the Parameter This is the identifier that the platform will use. It is read only.
Type of the Parameter By default is a select. So we only need to add new values.
Help Text This is an small description that it will be shown on the Webhook parameter inside the Webhook object.
Long Help Text This text contains a link to show more in detail how it works the parameter.
Values This parameter allows to include all the options that come from your server response. For instances in our example check the below image:

Finally we are ready to create a Flow that can use our webhook object. To perform that we need to drag and drop the new webhook object to our Flow canvas. This webhook will be ready to listen all response from your server when the flow is published.