Webhooks

Les webhooks permettent aux parties externes/applications de réagir à des événements internes dans Webship Online. Un webhook est une URL appelée par Webship Online lorsque se produit un événement spécifique. La partie externe peut alors prendre les actions nécessaires en fonction des informations fournies dans le webhook.

Via Paramètres > Webhooks, il est possible de créer et gérer des webhooks. Un webhook comporte un déclencheur, quelques filtres optionnels, une URL et peut être activé de manière permanente ou au sein d'un laps de temps spécifié (par exemple pour appeler les webhooks uniquement sur les commandes pendant une campagne commerciale temporaire).

Champs

Déclencheurs

Pour chaque webhook, un déclencheur doit être sélectionné. C'est l'événement auquel on cherche à savoir si le webhook doit être appelé. Certains déclencheurs importants sont par exemple :

  • Lorsqu'une commande est créée
  • Lorsque la stock est mis à jour
  • ...

Filtres

Les filtres sont facultatifs et peuvent être utilisés pour déterminer si le webhook doit être appelé ou non. Par exemple, un webhook peut être appélé uniquement lorsque la commande doit être expédiée vers un pays spécifique ou que le produit appartient à une certaine marque commerciale. L'ordre/produit/etc. doit satisfaire tous les filtres du webhook avant qu'il ne soit appelé.

URL

L'URL qui est appelée lorsque le webhook est activé. Cette URL doit être accessible en ligne et la partie externe doit pouvoir traiter l'information fournie dans le webhook.

Quand les webhooks sont-ils appelés ?

Les webhooks sont toujours exécutés après que le déclencheur de la webhook a été enregistré dans la base de données. Cela signifie que lorsque le webhook est appelé pendant la modification d'une commande, les données transmises correspondent à l'état actuel de la commande, y compris toutes les modifications apportées au cours du processus.

Détails techniques

Les webhooks sont appelés via une requête HTTP POST vers l'URL spécifiée. Les données fournies dans le webhook sous forme de objet JSON contiennent les informations sur l'événement qui a déclenché la webhook.

La requête du webhook comporte des en-têtes supplémentaires :

  • X-Hook-Trigger : Le déclencheur du webhook

  • X-Company-Id: L'identifiant de l'entreprise au sein de Webship Online auquel appartiennent les données transmises

    ?> Le X-Company-Id peut être utilisé pour effectuer des requêtes API supplémentaires si nécessaire.