Webhooks

Les webhooks permettent aux parties externes/applications de réagir aux événements qui se produisent dans Stoqflow. Une webhook est une URL qui est appelée par Stoqflow lorsque s'produise un certain événement. La partie externe peut alors prendre les actions nécessaires sur la base des informations transmises dans la webhook.

Via Paramètres > Webhooks, on peut créer et gérer les webhooks. Une webhook est constitué d'un déclencheur, des filtres optionnels et d'une URL qui peuvent être activés de manière permanente ou seulement pendant une plage de temps spécifique (par exemple, pour appeler uniquement les webhooks sur les commandes lors d'une promotion commerciale temporaire).

Champs

Déclencheurs

Pour chaque webhook, il faut choisir un déclencheur. Un événement auquel on regarde si la webhook doit être appelée ou non. Certains déclencheurs importants sont par exemple :

Lorsqu'une commande est créée
Lorsque les stocks sont mis à jour
...

Filtres

Les filtres sont optionnels et peuvent être utilisés pour déterminer si la webhook doit être appelée ou non. Par exemple, une webhook peut uniquement être appelée lorsque la commande doit être envoyée dans un pays spécifique ou que le produit appartient à une certaine marque de commerce. L'ordre/produit/etc. doit remplir tous les filtres dans la webhook avant qu'elle soit appelée.

URL

L'URL qui est appelée lorsque la webhook est activée. Cette URL doit être accessible depuis internet et la partie externe doit être capable de traiter l'information transmise dans la webhook.

Quand les webhooks sont-ils appelés ?

Les webhooks sont toujours exécutés après que le déclencheur de la webhook ait été enregistré dans la base de données. Cela signifie que lorsque une webhook est appelée lors d'une modification d'un ordre, les informations transmises seront celles du dernier état de l'ordre, y compris les modifications apportées pendant le processus.

Détails techniques

Les webhooks sont appelés via un requête HTTP POST vers la URL spécifiée. Les données transmises dans la webhook sont un objet JSON contenant les données sur lesquelles la webhook a été déclenchée.

?> Consultez notre documentation API pour plus d'informations sur la structure des différents objets qui peuvent être transmis dans les webhooks.

La requête de webhook comporte également les en-têtes suivants :

X-Hook-Trigger: Le déclencheur de la webhook
X-Company-Id: L'identifiant de l'entreprise au sein de Stoqflow à laquelle appartiennent les données transmises. Cela peut être utilisé pour par exemple effectuer des requêtes API supplémentaires.

!> Après 5 réponses négatives consécutives de la URL spécifiée, la webhook est automatiquement désactivée. La webhook peut être activée manuellement via les paramètres du webhook.