WebHook Integration

The WebHook Integration app allows the DataEngine to receive WebHooks from external systems, enabling real-time responses to events. This integration automates data flow between different platforms and the MARINI platform without manual intervention. It supports a wide range of WebHooks, making it versatile for integrating third-party tools.

Installation

To use the Webhook app, follow these steps:

1. Create a module (or use an existing module) in the DataEngine. For optimal use of the Webhook app, it is recommended to create specific fields in this module:
   • rawjson (optional): This field contains the request content as a JSON string.
   • path: This field contains the path part (the xxx/xxx part) from the POST request.
   • The JSON request is parsed and looks for fields with the same names as properties in the JSON. For example, the JSON {"EventType":"aaa"} will set the userId field if it exists.
   • If the JSON contains objects/arrays, they can be accessed with an underscore in the field name. For example, {"Properties":{"ClientId":"aaa"}} can be accessed using the field name properties_clientid.
   • Field names in the bean can be in any case, and custom fields are also checked, so they can be, for example, properties_ClientId_c.
   • A field named properties can contain a JSON string, e.g., {"ClientId":"aaa".
   • Custom configurations can be used for long field names.
2. Visit /index.php?entryPoint=WebhookToken to obtain an access token.

Sender

The sender of the webhook can send POST requests to the following URL:

• http://web.dataengine.docker/entrypoint/Webhook
• OR
• http://web.dataengine.docker/entrypoint/Webhook/xxx/xxx (where xxx/xxx is the path)

You should use the following headers in your POST request:

• Content-Type: application/json
• Authorization: Bearer <Access Token> (replace <Access Token> with your received access token)
• X-Signature (optional): <HMAC-Hash of Content>

The webhook will always create a new bean in the DataEngine. The user created is the one defined when creating the access token, and the module of the bean is also the one defined when creating the access token. The fields of the bean are filled according to the rules described above.

By using the DataEngine Webhook app, you can easily integrate data from external services into the DataEngine, thereby enhancing the efficiency of your data processing.

This app must be configured depending on the installed modules. For more information, visit https://marini.systems/en/help-center/docs/custom-config/#WebHook.