Appeler un webhook depuis un déclencheur

Mis à jour

Note : Cet article est technique, nous recommandons donc d'impliquer une personne ayant l'expertise technique adéquate. Si vous avez des questions, contactez-nous à support@azumuta.com.

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

Cet article explique comment configurer un déclencheur Call a webhook : où le paramétrer, 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 espace de travail. 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.

Consultez 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 appelez Azumuta en retour.

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 avec un plus).
  4. Remplissez les champs décrits ci‑dessous.
  5. Lorsque vous avez terminé, cliquez sur Add.

Quoi, Quand et Portée

Vous pouvez ensuite modifier ou supprimer le déclencheur, et consulter l'historique d'utilisation.

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 pour GET ou POST. La valeur par défaut est GET.
  • Payload : affiché uniquement lorsque la méthode est POST. Saisissez ici le contenu personnalisé du corps. La note de l'interface indique : “You can use parameters in this field.”

Ce qu'Azumuta envoie

Azumuta inclut toujours un apiKey provenant d'un Api Device de l'espace de travail, 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 comme colonne/action)
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 en 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 mentionnés ci‑dessus).

Votre système récepteur peut utiliser le apiKey inclus pour appeler le 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 liés

Note : L'article What’s New Configurable JSON Body When Using Webhooks annonçait historiquement la fonctionnalité de payload POST. Cette page est le guide actuel pour configurer les déclencheurs webhook.

Sur cette page