Bringg Webhooks

Introduction

Bringg Webhooks are HTTP POST methods, called callbacks, that Bringg sends to any URL you register in Bringg. Bringg user actions and updates called webhook events automatically trigger callbacks. Callbacks contain detailed information about events. The information is called a payload and is sent in JSON format. No polling is required. You register a URL for a specific webbook event once. Every time that event occurs, the callback payload is sent to your URL.

For example, you can register a webhook URL for the "order created" event. Every time an order is created, your URL receives detailed information about that new order. Likewise, you can register webhook URLs for automatic updates for events throughout the order lifecycle. These webhook events include every time an order is assigned to a user (driver), a user (driver) accepts or rejects an order, a user (driver) arrives at and departs order locations and way point locations, as well as inventory events, notes events, and other events. For a complete list of Bringg Webhook Events, see the List of Bringg Webhooks Events.

📘

Bringg Webhooks eliminate the need for polling many critical Bringg events.

Registering URLs for Bringg Webhooks

Register your URLs in Bringg for each webhook event. No additional configuration in Bringg is required.

To Register a Bringg Webhook URL:

  • In your company profile, go to Webhooks & API.
  • Click the WEBHOOKS tab. The webhooks panel appears.
  • In your required webhook text area, paste the URL to which this webhook callback will send its payload.
  • Select **Add URL" to include an additional URL endpoint.
    • Click Update. The webhook URL is registered.

Configuring Webhook API Security

There are four levels of security:

  1. None: Even though all of our networking is done with HTTPS, we do allow having no additional security. This is not recommended for production environments but can be useful for development purposes.
  2. Simple: HTTP standard authentication (aka HTTP authorization) - simple key security. This is also not recommended; however, some systems support only that and it’s better than no security.
  3. OAuth2 authentication: Secret public key pair type of security - industry standard .
  4. Custom: Write your own custom security .

The following is a list of the Bringg Webhook events. To see detailed information about a specific Bringg Webhook event and the detailed information in the callback, click the event name.

Filter webhook by task field

Sort webhooks triggered by the same event to different endpoints according to selected task field value.

  • In your company profile, go to Webhooks & API.
  • Click the WEBHOOKS tab. The webhooks panel appears.
  • Select "Add Webhook" or "Edit" on an existing webhook.
  • Select the relevant webhook from the drop down menu.
  • Select the relevant task field, which will populate according to the selected webhook.
  • Insert the relevant value and URL.
  • Click Save.
  • Repeat steps to send the same webhook to a different endpoint using another task field value.

📘

Task refers to Order

Flexible webhooks

Add or remove data fields you receive for a specific callback event.

To adjust webhook content:

  • In your company profile, go to Webhooks & API.
  • Click the WEBHOOKS tab. The webhooks panel appears.
  • Select "Add Webhook" or "Edit" on an existing webhook.
  • Uncheck the "Show selected" option.
  • Check any data you wish to receive for this webhook.
  • Click Add.

You can restore default data for a webhook any any time.

Note: Not all webhooks have the flexible functionality. We will keep adding & transforming webhooks to this structure according to requests.

❗️

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.