Appeler un webhook depuis un déclencheur

Mis à jour

Note : Il s'agit d'un article hautement technique. Nous vous recommandons donc d'y associer votre service informatique lors de sa lecture. Pour toute question ou demande, contactez-nous via support@azumuta.com — nous nous ferons un plaisir de vous aider.

Lorsque Azumuta doit notifier un autre système qu'un événement s'est produit (par exemple, qu'une commande produit a été complétée ou qu'un incident a été signalé), préférez un déclencheur Call a webhook plutôt que d'interroger périodiquement l'REST API. Les webhooks échangent uniquement les données nécessaires au moment où l'événement se produit. Pour le schéma d'intégration ERP plus général, voir ERP Integration.

Cet article explique comment configurer un déclencheur Call a webhook : où le configurer, quels attributs renseigner et ce qu'Azumuta envoie à votre endpoint.

Prérequis

Les déclencheurs webhook incluent un apiKey provenant d'un Api Device de votre workspace. Vous devez avoir au moins un Api Device configuré. Si aucun n'existe, le webhook échoue avec une erreur telle que No api device configured.

Voir Create and manage API keys pour savoir comment configurer un Api Device, et Azumuta’s REST API pour comprendre comment cette clé est utilisée lorsque vous interrogez Azumuta.

Ajouter un déclencheur webhook

  1. Cliquez sur Settings sous Management.
  2. Cliquez sur Triggers sous Integrations.
  3. Cliquez sur Add trigger (le bouton jaune plus).
  4. Remplissez les champs décrits ci‑dessous.
  5. Lorsque vous avez terminé, cliquez sur Add.

Quoi, Quand et Portée

Vous pouvez ultérieurement edit or delete le déclencheur, et consulter l'usage history.

Attributs

Après avoir sélectionné What et When, la section Attributes affiche les options du webhook :

  • Endpoint : l'URL HTTPS qu'Azumuta appellera (le placeholder commence par https://). Cet endpoint doit être accessible depuis les serveurs d'Azumuta.
  • Method : boutons radio GET ou POST. Le défaut est GET.
  • Payload : affiché uniquement lorsque la méthode est POST. Saisissez ici le contenu personnalisé du corps de la requête. La note de l'interface indique : “You can use parameters in this field.”

Ce qu'Azumuta envoie

Azumuta inclut toujours un apiKey issu d'un Api Device du workspace, ainsi que des champs spécifiques à l'événement :

Portée Champs typiques
Product orders identifier (numéro de commande produit), et le cas échéant workinstructionId et recordingId
Issues issueId, issueNumber (et pour certains événements, des champs liés aux colonnes/actions)
Audits recordingId, workinstructionId, et des champs d'audit associés tels que auditNumber

La manière dont ces champs sont transmis dépend de la méthode :

  • GET : les champs sont ajoutés en tant que paramètres de requête URL.
  • POST : les champs sont envoyés au format JSON dans le corps de la requête. Si vous avez configuré un Payload personnalisé, ce contenu est imbriqué sous la clé payload dans le corps JSON (aux côtés de apiKey et des champs d'événement ci‑dessus).

Votre système récepteur peut utiliser le apiKey inclus pour appeler l'Azumuta REST API afin d'obtenir des données supplémentaires si nécessaire — un schéma courant avec une couche d'intégration devant un ERP.

Articles connexes

Note : L'article What’s New Configurable JSON Body When Using Webhooks annonçait historiquement la fonctionnalité de corps JSON configurable pour les requêtes POST. Cette page décrit la procédure actuelle pour configurer les déclencheurs webhook.