Overview

Webhooks allow you to send information about your licensed Mendix app deployed to the Mendix Cloud or Mendix for Private Cloud to an external app or workflow. This can be used, for example, to trigger an automated CI/CD workflow when a new change is committed to the Team Server.

You can send the webhook event to an external app or workflow, including a Mendix application. The first step of processing the webhook event is verifying the signature of the webhook request. Only if the signature of the request is validated, the event should be processed.

This module helps you with validating the signature of the webhook request, by providing a microflow that validates the signature of the request. It also provides an example implementation of a published REST service to process the webhook events.

Documentation

Description

Webhooks allow you to send information about your licensed Mendix app deployed to the Mendix Cloud or Mendix for Private Cloud to an external app or workflow. This can be used, for example, to trigger an automated CI/CD workflow when a new change is committed to the Team Server.

You can send the webhook event to an external app or workflow, including a Mendix application. The first step of processing the webhook event is verifying the signature of the webhook request. Only if the signature of the request is validated, the event should be processed.

This module helps you with validating the signature of the webhook requests, by providing a microflow that validates the signature of the request. It also provides an example implementation of a published REST service to process the webhook events.

Typical Usage Scenario

This module helps you with validating the signature of webhook requests, by providing a microflow that validates the signature of the request. It also provides an example implementation of a published REST service to process the webhook events.

Features and Limitations

• Microflow to validate the signature of a webhook request

• Example implementation of a published REST service to process the webhook events

• Dependencies

• Community Commons module

Implementation

Add the dependencies to the project. Then add the module to your project.

Use the ValidateMxWebhookSignature microflow to validate the signature of the webhook request. This microflow is also exposed as a microflow action called Validate Signature.

You can check the Examples folder for an example implementation of a published REST service to process the webhook events.

Troubleshooting

The module will log the result of the signature validation in the application log with log level INFO. It will log an error if the signature is not validated, providing more information on why the signature can’t be validated.

Known Issues

None