Overview
The webhooks feature allows your platform (outside of your ecommerce platform) to receive an output of address data whenever the customer updates their shipping address. The webhook will trigger automatically once this action occurs, and is helpful if your 3PL / ERP / WMS cannot receive timely updates from your ecommerce platform (ex: Shopify).
This integration is available for all merchants, and takes a few seconds to setup.
Types of Webhooks
Today we support 2 types of Webhooks:
Updated Address
Confirmed Address
The updated address webhook will trigger when the customer updates their shipping address. Whereas, the confirmed address webhook will trigger once the customer confirms their original shipping address without making any updates.
Depending on your logistics workflow, we recommend enabling both options for timely updates. To get started:
Go to: Integrations > Webhooks. Once on this page, paste in your URL, enable the selected webhook, and finally click Save.
Payload Example
Below is an example payload of the updated address webhook, displaying both the new shipping address and the old shipping address. We also pass in the OrderID, so its easy to align with your platform's data mapping requirements.
By showing both data groups within the payload, this can be helpful if your platform needs to compare both data inputs for analytics or for storage purposes.