V3 Webhook Update: New Client & End-Customer Tracking URLs

Announcements
1

:new: What’s new?

We are excited to announce some improvements made to our V3 webhooks!

  • A new field has been added to the V3 webhook payloads, called client_tracking_url.
  • The existing tracking_url has been renamed to end_customer_tracking_url to improve clarity.

:magic_wand: What’s the impact?

To ensure your integration continues to work as expected, please review the payload fields. You will need to update your integration to retrieve the correct tracking link.

Here’s what’s changed:

  • New client_tracking_url field:
    • Contains additional widgets, such as a customer support (CS) widget for your team to access live support.
    • Includes Proof of Delivery (POD).
    • Tracks your order and allows your staff to manage the process from a single live tracking page.
  • Renamed end_customer_tracking_url field:
    • Intended for end-customers, is the current tracking_url provided in our webhooks to track the courier’s live progress and get updated ETAs and delivery statuses.

:hammer_and_wrench: Action Required

  • Ensure your webhook integration is updated to pull both the new client_tracking_url and renamed end_customer_tracking_url fields. This is essential for retrieving tracking links and ensuring your integration follows best practices.

:bulb: How does it work?

The new tracking URLs will be available in the following V3 webhook events:

  • package_created
  • courier_assigned
  • courier_waiting
  • package_delivering
  • package_delivered

Example payload:

{
  "version": "v3",
  "occurred_at": "2024-09-17T14:26:42.916Z",
...,
    "package": {
      "id": "100803824",
      "reference": "Test",
      "client_tracking_url": "https://stuart.sandbox.followmy.delivery/2edc9e7032023929f3a5c61170a5a68e/100803824/331e0a2e57e570ffc87a8ddef166707f",
      "end_customer_tracking_url": "https://stuart.sandbox.followmy.delivery/100803824/331e0a2e57e570ffc87a8ddef166707f"
    }
  }
}

:date: When will this change take place?

  • The new webhook changes are already live in our sandbox environment for testing.
  • These changes will go live in the production environment on 1st November 2024.

:eyes: What’s next?

We will continue to enhance our webhooks events. Stay updated by subscribing to our Announcement notifications.

Make sure to test the new features in your sandbox environment and be prepared for the production release!