Create New

Within the list of the webhooks, it is possible to click the New button to create a new webhook.

Name

Enter here a name that describes the purpose of the webhook.

Action

Select the trigger of the webhook. Every action might support additional parameters.

Take a look at the Supported Actions for further details.

Delivery URL

The end-point URL where the request payload will be delivered. Every time the selected action is triggered, the system will send some data to the specified URL.

The payload request always specifies a Content-Type equals to application/json.

Secret Key

An optional secret key to be included within the request headers. When specified, the X-VAP-WEBHOOK-SECURE directive will specify a MD5 hash of the secret key.

In example, if you specify a secret key equals to ABCD1234, the end-point will be able to validate the secret key with the following code:

$secret_key = md5('ABCD1234');

if (empty($_SERVER['X-VAP-WEBHOOK-SECURE']) || strcmp($secret_key, $_SERVER['X-VAP-WEBHOOK-SECURE']))
{
    // invalid secure key, raise 403 error
    header('HTTP/1.1 403 Forbidden');
    echo 'You are not authorised to access this resource';
    exit;
}

Published

Whether the webhook should be executed or not.

Parameters

Under this section you might see different parameters depending on the selected action.

Logs

This list contains all the log files that have been created during the execution of the webhook. Select a log file and click the Load button to see all the registered information. The logs should contain the request information and the received response.