Skip to main content

How can we help?

Search

Event subscriptions

Edited:

A custom app can subscribe to other events and push data to a particular endpoint.

These event subscriptions live in the Event Subscriptions tab inside the custom app.

 

This tab will list any event subscriptions that have been defined for this custom app already.

Edit existing subscriptions by tapping on them or create a new subscription by using the Add Subscription button.

event-subscription.PNG

The event subscription tab of the custom app

 

Creating an Event Subscription

Event subscription

An event subscription requires you to:

  1. Client (optional)
    1. The Client Partner of consignments and/or schedules you want to subscribe to events for
  2. Carrier (optional)
    1. The Carrier Partner of consignments you want to subscribe to events for
  3. Consignment Events
    1. The different consignment events you want to subscribe to.
    2. Each event will have a different payload
  4. Schedule Events
    1. The different schedule events you want to subscribe to.
    2. Each event will have a different payload

 

Webhook Endpoint

The final piece of the trigger requires an endpoint to be provided with which to POST the data to.

Enter the URL, and optionally enter a signing key in the Signing Key 1 or Signing Key 2 field.

  The signing key will compute a SHA256-HMAC on the body of the message and provide the signature in the header of the request.
Signing Key 1 will be referenced as x-consignly-signature-1 and Signing Key 2 will be referenced as x-consignly-signature-2.

 

Payload Definition

The firing of different events will push a payload to the defined endpoint.

View the different payload definitions.

 

Removing a Subscription

To remove an existing subscription, tap into the subscription and using the action menu, choose Remove Subscription.

remove-subscription.PNG

The remove subscription action menu