Shipment event filters

  • track
  • ui
  • manage shipments

Before enabling real-time notifications or webhooks in Track, you must first create a Shipment Event Filter. These filters "catch or filter" the exact delivery events (E.g. delays or delivery failures) that you want to identify in your Track system.

Shipment Event Filters are required to activate key Track features. Once set up, they allow you to:

  • Send real-time notifications to customers through email or text (SMS).
  • Trigger webhooks to external systems.

This ensures that Track responds only to the shipment events you’ve defined, giving you full control over which updates are triggered. As a result, your customers stay informed and their delivery expectations are managed more proactively by reducing WISMO.

Create a new shipment filter

To create and manage shipment event filters in Track, go to the Settings > Shipment event filters page.

  1. Go to Settings > Shipment event filters.

    Select Add shipment event filter.

    filter-home

  2. Type a Shipment Filter name & click Next.

    filter-name

    Tip

    We recommend the filter name should be related to the business process you want to drive with the filter. For example, "Contact Required" would be a better choice of filter name than "SMS".

  3. Click to select the carriers you want in the shipment filter.

    (Optional) You can click to Select all carriers.

    When done, click Next at the bottom.

    Note

    If you do not select any carriers, the filter will trigger for shipments with all carriers.

    new-filter-select-carrier

  4. Click to select the Shipment states and/or Calculated events you want in your Shipment filter. At least one selection is required.

    Click for more information on Shipment states & Calculated Events

    When done, click Next.

    The example below uses the filter to find the Delayed Shipment state & then selects the Late Calculated event. filter-ship-states

  5. View your selections & click Next to confirm.

    (Optional) From here, you can click to remove any states or events you don't want anymore.

    filter-view-selection

  6. Click the shipment types you want to include in your filter. When done, click Next.

    (Optional) You can click to Select all shipment types if you want.

    filter-types

  7. (Optional) Add any shipment tags you want by typing a name & clicking the plus button. If you add tags here, only the shipments that include your defined tag will trigger a webhook.

    When you have added any tags you need, click Create Filter to finish. Your new filter appears as a tile on the Shipment Filters page.

    Note

    You can add tags to shipments via the Register Shipments & Update Shipments endpoints. For more information, checkout our guides on Registering Shipmets (API) and Updating Shipments (API).

    filter-types

  8. (Optional) You can click the tick box if you want to trigger the shipment filter once per grouping. If you do not want this, just click Create Filter. For more information, see our article on Shipment Groupings.

    Once you have clicked the tick-box, use the drop-down to choose the Grouping Metakey & type how long you want to restrict for (in minutes). When done, click Create Filter.

    filter-restrict

Well done! You have created a Shipment Filter. If you are following this guide as part of setting up webhooks, click here for our guide. Otherwise, scroll down if you want to find out how to edit Shipment filters.

Edit or delete a filter

  • To edit an existing shipment filter, click the Edit icon in the filter row. The process of editing an existing filter event is the same layout as how you would create one.

  • To delete an existing shipment filter, click the Delete icon in the filter row. You cannot delete a shipment filter if it is currently being used by one or more webhooks.

    delete-edit

User access

Admin & Marketing users can view, edit & delete shipment filters.

Dashboard users do not have access to this feature.

Next steps