Bringg Webhooks
Set up webhooks to sync related systems.
Use Bringg webhooks to notify other enterprise systems in real-time as soon as a predefined event occurs. For example, update your order management systems (OMS) when an order arrived at its destination.
Bringg webhooks are HTTP POST methods that do not require polling. You register a URL for a specific event once. Every time that event occurs, the webhook is sent to that URL.
You can have multiple systems listen to the same webhook rather than each making an independent data request. The webhook sends data in its payload to designated URLs.
Any applications subscribed to a single webhook receive the payload at the same time, but its content may vary depending on the parameters which each system requires.
For example, if you register a webhook URL in your OMS and ERP for the event Order Is Cancelled, the OMS receives one payload belonging to Order Is Cancelled to update the status of this order. At the same time, the ERP receives a slightly different payload with details to update the inventory.
For a complete list of Bringg webhook events. Learn more.
Before You Begin
Confirm you have a Bringg user of type Admin.
Procedure
-
Select your username > Settings > Platform Integrations > Webhooks > Add Webhook to register for a new webhook event.
-
Select an event in the order life cycle.
For a complete list of Bringg webhook events. Learn more. -
Enter a URL for each endpoint.
Select Add URL to enter multiple endpoints.
You can have multiple systems listen to the same webhook rather than each making an independent data request. The webhook sends data in its payload to designated URLs. -
Configure webhook security by selecting the Authorization method:
| Field | Description |
|---|---|
| Jason web token (JWT) | This method consists of three parts: a header, a payload, and a signature. The header contains information about the type of token and the algorithm used for the signature. The payload contains the claims or information about the user or entity being authenticated. The signature is created by hashing the header and payload with a secret key to ensure the integrity of the token. |
| Static headers | Include an authorization token or API key in the header of the HTTP request. |
| OAuth2.0 | Include Client ID, Client Secret, Auth URL, Path, Request Type, and Scope. |
- (Optional) You can send webhooks triggered by the same event to different endpoints (URL) depending on an event detail, by selecting an event field and entering a target value.
For example, a carrier may want to receive webhooks only for orders assigned to them. - Select the data fields you want to receive in response to the event by selecting Enable Flexible Webhook then selecting the fields you need.
Choose Selected Data to view all the fields that will be included in the payload.
You can restore default data for a webhook at any time by selecting Restore Default Data.
Updating Flexible Webhooks
When adding, removing or modifying the fields to be included in your flexible webhooks, the structure of the webhook payload may change.
When making any updates, make sure to test the updated webhooks and make any necessary adjustments to your receiving endpoint.
Updated about 2 months ago