Webhook Configuration & Setup

This section shall outline how a KYCMATIC administrator at a Subject Person may be able to create, alter as well as manage the Webhook configuration being used between KYCMATIC and a third-party solution, such as an internal back office solution. 

On selection of the menu item, the user is directed to a screen similar to above. Here the user would be able to view (using the tabs) the Webhook URLs & Actions which shall be used to contain the main and generic URL’s which shall typically point to the third-party solution the subject person would like to utilise outside of KYCMATIC as well as the list the individual actions (URL paths) that would work in conjunction with the Webhook URL.

The Webhook URL defines the system which is about to be invoked, whilst the Webhook Actions defines the path (a status) that shall be sent to the system.

The above example provides the user with a list of available Webhook URL’s which are made up of:

• Friendly Name – a readable friendly name given to the URL;

• Endpoint URL – the actual URL pertaining to the third-party solution;

• Retry Attempts - the amount of retry attempts the webhook would utilise provided there was an issue with the initial or previous attempt;

• Retry Interval - the time elapsed between one try and an other;

• Active – implying whether the webhook URL is to be made use of or not;

• Edit – Enabling the user to alter the Webhook URL details;

• Delete – Deleting the Webhook URL;

As the KYCMATIC Administrator selects the 'Add URL' button, the user would be presented with a popup which shall be similar to the images above. Here the user would be able to provide a:

• Friendly Name to quickly identify the scope / name of the Webhook URL and Action;

• Configure the URL the Webhook would utilise;

• Configure the Exponential Back-off Retry Policy;

• State whether the Webhook is to utilise authentication or not, and if required, to configure the:

  • Authentication Service URL;

  • Service ID;

  • Username;

  • Password;

Optionally, the user may also test the authentication by selecting the 'Test Authentication' button, to ensure that the credentials and configuration is correct.

A Typical Webhook Structure

A Webhook will be sent to a configurable URL as a POST request with the following attributes in the body JSON object:

Webhook Body JSON Example

Retry Policy

In case of failure to send a request, an exponential back off will be implemented, whereby the ‘Retry Attempts’ and ‘Retry Interval’ (in seconds) would be configurable by the subject person.