Event Cast API

The Event Cast API can be used to subscribe to tracking events for a given shipment using webhooks. Event notifications are automatically pushed to the subscriber as they happen, which makes it unnecessary to repeatedly poll statuses calling the Tracking API. You define an endpoint that accepts HTTP POST, and whenever an event is registered for a subscribed shipment, we send it to the URL.

Events

When registering for a Webhook you can choose between a range of different event groups that you can subscribe for. It is recommended to limit the amount of events to subscribe for. Bring will send an event on each of the events occurred which in result may send quite a few HTTP-requests to your server. So, as a good practise, keep the list of event groups as small as possible.

Each of the event groups corresponds to a certain set of actions that can happen to the package/shipment you subscribe for. For instance, if you subscribe to DELIVERED, all internal Bring-events will trigger a request to your defined callback URL.

Event groups

Default set of subscribable event groups. Notice that this list is subject for change.

There is also a specific set of events that will be sent if something deviates from the normal event flow:

Subscribing to multiple event groups

The Webhook API supports the possibility to subscribe to multiple event groups at the same time. Doing so requires that groups are separated with comma and is defined as an array. Example:

['IN_TRANSIT', 'NOTIFICATION_SENT', 'TERMINAL', .., ..]

Need more examples? See the “Create Webhook” section below.

Receiving Callbacks

In order to receive requests from Bring, your callback URL must be accessible on the internet and able to receive requests from Bring IPs. Additionally, to minimize risk, you should also provide HTTPS-enabled endpoints and use some kind of authentication mechanism. For HTTPS, please do not use self-signed certificates, as requests may fail from Bring’ side and you’ll receive no requests.

If you need a simple authentication whilst receiving requests from Bring, we recommend utilizing the header functionality provided by the Webhook configuration.

All received callbacks from Bring will be using UTC as its current timezone and is based on the following format (Java):

"yyyy-MM-dd'T'HH:mm:ssZ"

Payload

Payload delivery headers

HTTP POST payloads that are delivered to your Webhook’s configured URL endpoint contains several Bring specific headers:

Example

Requests issued from Bring to your endpoint will look similar to this:

POST /callback/Webhook HTTP/1.1
host: localhost:80
Accept: application/json
User-Agent: Bringcast-Webhook/v1.0.34-SNAPSHOT
X-Bring-Application: BMEC
X-bring-Correlation: xA3n7
X-some-fancy-custom-header: with-some-value-that-I-expect
Content-Type: application/json
Content-Length: 188

{
  "status": "IN_TRANSIT",
  "id": "ad84cbca-2e89-43e0-a301-a8d5d7fe7804",
  "shipment": "SHIPMENTNUMBER",
  "package": "TESTPACKAGEDELIVERED",
  "created": "2019-03-16T14:58:48+0000",
  "pushed": "2019-03-16T14:58:49+0000"
}

Q & A

Can I have multiple Webhooks for the same parcel?
You can register for multiple Webhooks on the same parcel/shipment, as long as the event groups are different for each registration.

How many active Webhooks can I have simultaneously?
Currently there is no limitation.

Is the expiration duration configurable?
No.

Can I get a history of events that were sent for a subscription?
Not in this version. It may be available in the future. Please note that you may use the Tracking API if you’d like the entire list of events that has happened for a lifecycle related to a shipment.

Will I be able to see my previous/expired Webhooks (active and inactive)?
No.

What happens if our endpoint is down and a callback is being sent?
We’ll try issuing a request to your defined endpoint up to three - 3 - times with a delay on 30 minutes for the two first, then wait an hour for the last retry. After this, callbacks will not be retried.

Do you support wildcard events/event groups (e.g * or ALL)?
No.

Do you support modifying existing active webhooks?
No.

My shipment is not yet registered with Bring, will registering for Webhook work related to that tracking number?
Yes.

When you subscribe for a parcel that does not yet exist in Bring’ systems, a retry mechanism will try for up to two - 2 - days to ensure that the Webhook will be registered when the parcel is found internally. Eventually, if the package was not found with Bring within this timeframe - a notification will be sent on the callback URL configured for that Webhook which notifies this.

Note: Retry-timing is non-configurable.