Mender supports Webhooks to send data to third-party systems. With this mechanism, it's possible to notify external applications about device lifecycle events. This helps you avoid polling and manual synchronization between Mender and other systems.
This integration is available in all Mender plans, as well as Mender Open Source.
You need a device integrated with Mender, see the Get started guide.
You need an external service or application exposed on the internet and able to receive data from Mender in the form of an HTTP POST request.
A Webhook fires on device lifecycle events:
To send data from Mender to your application, you need to set up the integration by providing a unique URL and an optional secret.
Open the Mender UI and navigate to
Webhooks integration and enter your application URL and necessary credentials (optional):
After creating the Webhooks integration, you will see it in the integrations list.
You can see details of a given Webhook integration after proceeding to its details:
You can also see the Webhooks activity in the
The event data sent to your application, depending on the event type, may look like this:
The list of allowed event types follows:
The device authentication event consists of the following fields:
id - device unique ID,
status - the authentication status of the device,
auth_sets - array of device authentication sets,
created_ts - the time the device was initialized in Mender.
The properties included depend on the event type:
More information about payload possibilities are available in the iot-manager management API specification.
If you specify a secret, an integrity check is calculated and located in the
X-Men-Signature-Payload header, which contains the HMAC-SHA256 of the payload using the configured secret.
Role Based Access Control is only available in the Mender Enterprise plan. See the Mender features page for an overview of all Mender plans and features.
Admin permission is required to set up the integration.
© 2024 Northern.tech AS