The Hook is an extension of the Feed v3, tailored to robust operations that require more complex integrations. Its main functionality is avoiding an unnecessary feed query by a system or user without having new events, notifying the configured endpoint whenever an order status update occurs.
Configure at which endpoint you will receive Hook notifications and which events you will be notified about by using the API Hook Configuration.
Feed v3 and Hookenabled access profile within OMS.
filterfor the Hook configuration API, the endpoint will be notified of any and all events.
According to the status of the API filter, the Hook notifies the configured endpoint each time a new event is logged on its feed. Due to the infrastructure required to maintain endpoint notifications, there are two scenarios in which the Hook configuration can be removed from your account:
If an event is incorrectly sent to the endpoint, the interval for future retries is calculated based on an internal geometric progression algorithm.
One hundred notification retries may be performed. If all the 100 are unsuccessful, the Hook configuration is removed and VTEX will no longer send notifications to the endpoint until a new configuration is implemented.
server code 200.
If the configured endpoint is not notified within a 3-day period, meaning that if your feed does not record any new event that qualifies for a notification during the time period, the Hook and Feed v3 configurations are then discarded.
It is imperative to check the defined status filters of the filter object within the Hook API configuration, since the configured status of this object defines which events trigger notifications. It's possible for the configured filter to limit notifications sent to your endpoint, thus impairing the Hook configuration.
We recommend to always configure Hook on the main account. Even in robust operations, configuring Hook on different franchise accounts increases the possibility of the configuration being removed due to lack of endpoints notifications.
A main account on the other hand has a much larger events flow, since it carries all of the franchise accounts orders as well. This ensure that the configured endpoint is constantly notified and that there is greater visibility to commit all the events correctly.