Enhanced delivery profile webhooks now include additional payload fields

Enhanced Delivery Profile Webhooks Now Include Additional Payload Fields

We've improved the profiles/update webhook by adding more comprehensive payload information. This enhancement significantly increases webhook reliability and reduces unnecessary debouncing.

What's New

Previously, profiles/update webhooks only included the profile ID in their payload. This minimal payload led to an issue where multiple rapid updates to the same delivery profile were debounced by our webhook delivery system, meaning only the first update within a 15-minute window would reach your app.

Now, when you subscribe to profiles/update webhooks, you'll receive these additional fields:

• name: The profile's display name
• default: Indicates if this is the default delivery profile
• profile_type: The type of delivery profile
• version: An integer that gets incrementned whenever the profile or its shipping rates are modified

Why This Matters

If your app responds to delivery profile changes—such as for shipping rate synchronization, fulfillment optimization, or carrier integrations—you can now reliably receive every update. This is especially useful when merchants make quick successive changes to their shipping configurations, such as:

• Adjusting weight-based rate conditions
• Modifying zone configurations
• Updating multiple shipping rates in sequence

The new version field acts as a fingerprint of the profile's current state. It increments whenever the profile or its associated shipping rates are modified, ensuring each webhook has a unique payload that won't be debounced.

Using the Enhanced Payload

The enhanced payload structure is as follows:

{
  "id": 123456789,
  "name": "Standard Shipping",
  "default": false,
  "profile_type": "shipping",
  "version": "1"
}

This enhancement is available now in API version unstable and will be included in the next stable API release.