Manage Webhooks
warning
This section is a work in progress.
Webhooks is the way to get notified if an entity changes in Wino and stay in sync with Wino.
Common Webhooks use cases include the following:
- Sending notifications to clients
- Collecting data for data-warehousing
- Integrating with an online store
- ...
#
Register a Webhooks subscriptionnote
To have access to the API url and the API Key, please contact the Wino team by email at hello@wino.fr
.
To save your notification URL on our system, make the following request and add your notificationUrl
to it:
Once the POST
is issued against the subscription API to create the subscription, Wino will issue a request to the notificationUrl
, passing a token
parameter on the query string. Subscriber needs to perform the handshake by returning token
in the response body
and provide status code 200
:
RESPONSE
If Wino receives the response containing the token
, the subscription is registered and webhook notifications will be sent to your notificationUrl
.
#
Notifications and change typesOnce you register your notification URL, you will be able to receive notifications as follows:
#
ExampleAfter the create or the update of a variant, you will receive this sample of data:
We will then note the presence of the one-to-one relationships that are given to you. So, you will be able to perform the following GraphQL call to retrieve the linked product :
- GraphQL
- JavaScript
- PHP
And receive:
#
Additional notesBefore using the Webhooks system, please familiarize yourself with the following:
- A variable delay is to be taken into account before notifications are received. In some cases, the delay can be up to a few minutes. It is linked to the time required to synchronize the shop's data on his POS application, which follows an offline-first strategy.
- Today, only the product catalog schemas
Price
,Product
,StockActivity
,Tax
,Variant
andVariantPrice
are compatible with the Webhook system. - If you have any problems using the webhooks, do not hesitate to contact customer support at the following address:
help.wino.fr
or by email athello@wino.fr
.
In the future, as a result of feedback from developers, we plan to make the following changes:
- Notifications are sent in the following in a queue. If a notification fails to be sent, 10 delayed sending attempts will be scheduled. If there are 10 consecutive failures, then the Webhooks subscription is automatically deleted. A warning that the subscription will be deleted is sent to the app's emergency developer email address.
- To guard against webhooks duplication and flooding, Wino uses webhook de-duplication. This reduces the total amount of webhooks when multiple update actions are performed against an API resource in rapid succession.