Automatically receive tracking updates as soon as they are available.
Webhooks are a powerful method of automating use cases and improving productivity. Simply put, data is sent from one system to another in response to a triggering event. This article provides an in-depth webhook walkthrough if you are still getting familiar with the topic.
Where a static API provides read operations, webhooks provide dynamic resources. They allow your systems to react to events as soon as they occur, eliminating the need for polling or retrieving data at specified intervals.
Enabling webhooks
When creating a reference include a valid callback_url.
Vizion will begin periodically checking for updates. When new tracking data is available, Vizion API will send an update via HTTP POST to the provided callback_url parameter.
If the callback_url has been excluded, the update payloads must be fetched from the GET reference updates endpoint.
Disabling webhooks
You must unsubscribe the reference associated with the updates in question. If you do not unsubscribe and are not using our auto-unsubscribe feature, Vizion will continue to send updates to the callback_url provided.
Best practices
Review the following practices to ensure your webhooks remain secure and functional.
Respond to a webhook POST
Returning a successful HTTP response code such as 200 will inform Vizion that your system successfully received the update; otherwise, the POST will be handled as a failure and retried at the next scheduled interval.
Verify events sent from Vizion
Vizion sends webhook events from a set list of IP addresses, only trust events from these IP addresses.
Verify the HMAC signature to confirm that the received event is from Vizion.
Enterprise webhook authentication
Vizion can support industry-standard authentication for Pro plan customers. For further assistance, please contact support.
Development callback_url
We recommend using a tool like webhook.site to generate a usable callback_url for testing purposes only. Verify that the pricing, uptime, and expiration time work for your testing purposes. We cannot verify the uptime of this third-party service.