Notifications/Webhooks

For certain events, the Nitrobox can send a notification (via webhooks) to another system. Notifications must be activated and set up. Notifications are sent asynchronously. Notifications are used, for example, to pick up an invoice document that has just been generated and make it available to the customer, or to trigger further follow-up processes in a third-party system (e.g. an e-commerce shop).

Setup

You can set up to use our Webhooks via the Webportal. Navigate to Configuration -> Global -> Notifications.

Set up the necessary security configuration, and then specify which event should be POSTed to which of your APIs.

Authentication

NBX uses OAuth2 with client credential flow to authenticate against your configured endpoints. Our Notification Service will send the client_id and client_secret in the Basic Auth header and the trant_type=client_credential in the body with contentType application/x-www-form-urlencoded

Retry policy

If an attempt to send a notification fails, we will attempt to resend the notification with an ever-increasing interval, starting at 2min, increasing the offset by a factor of 4 per attempt. We will make a maximum of 10 attempts with a maximum offset of 12h.
With this set up, the last automatic retry will be attempted about 3 days after the initial failure.

If it still didn't work you will find the notification in the notification log and can trigger the retry manually.

Notification log

In our Webportal under Configuration, -> Global -> Notification you will find a table at the bottom with all notifications attempted to send to your system. You will also find all failed notifications here and can retry them manually.
This can also be used to resend notifications that were previously already sent successfully, in case they got lost in your system for some reason.

Available Notifications