Appeler un webhook depuis un déclencheur

Mis à jour

Note : Cet article est très technique. Nous vous recommandons donc d'impliquer votre service informatique lors de sa lecture. Pour toute question ou demande, veuillez nous contacter à support@azumuta.com — nous serons heureux de vous aider.

Quand Azumuta doit notifier un autre système qu'un événement s'est produit (par exemple, la finalisation d'une commande produit ou le signalement d'un problème), privilégiez un webhook trigger plutôt que l'interrogation périodique de la REST API. Les webhooks n'échangent que les données nécessaires au moment où l'événement survient. Pour le schéma 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 remplir et ce qu'Azumuta envoie à votre endpoint.

Prérequis

Les webhook triggers incluent une apiKey prise depuis un Api Device dans votre espace de travail. Vous devez disposer d'au moins un Api Device configuré. Si aucun n'existe, le webhook échoue avec une erreur telle que No api device configured.

Voir How to 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.

Comment 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 edit or delete le trigger, et consulter l'usage history.

Attributes

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 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'UI indique : “You can use parameters in this field.”

Ce qu'Azumuta envoie

Azumuta inclut toujours une apiKey provenant d'un Api Device de l'espace de travail, ainsi que des champs spécifiques à l'événement :

Portée Champs typiques
Commandes produit 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 à la colonne/action)
Audits recordingId, workinstructionId, et des champs d'audit associés comme auditNumber

La façon 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 liés à l'événement cités ci‑dessus).

Votre système récepteur peut utiliser la apiKey incluse pour appeler la Azumuta REST API afin d'obtenir des données supplémentaires si nécessaire — un schéma courant consiste à placer 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 payload en POST. Cette page est le guide actuel pour la configuration des webhook triggers.