Remarque : Cet article est hautement technique. Par conséquent, nous vous recommandons d'impliquer votre département informatique lors de sa lecture. Si vous avez des questions ou des demandes, veuillez nous contacter à l'adresse support@azumuta.com - nous serions heureux de vous aider.
Lorsqu'Azumuta doit notifier un autre système qu'quelque chose s'est produit (par exemple, une commande de produit a été complétée, ou un problème a été signalé), préférez un déclencheur webhook à l'interrogation périodique de l'API REST. Les webhooks échangent uniquement les données nécessaires au moment où l'événement se produit. Pour le modèle d'intégration ERP plus large, consultez Intégration ERP.
Cet article explique comment configurer un déclencheur Appeler un webhook : où le configurer, quels attributs remplir et ce qu'Azumuta envoie à votre point de terminaison.
Conditions préalables
Les déclencheurs webhook incluent une apiKey provenant d'un Appareil API dans votre espace de travail. Vous devez avoir au moins un Appareil API configuré. S'il n'en existe pas, le webhook échoue avec une erreur telle que No api device configured.
Consultez Créer et gérer les clés API pour savoir comment configurer un Appareil API, et API REST d'Azumuta pour savoir comment cette clé est utilisée lors de l'appel d'Azumuta.
Ajouter un déclencheur webhook
- Cliquez sur Paramètres sous Gestion.
- Cliquez sur Déclencheurs sous Intégrations.
- Cliquez sur Ajouter un déclencheur (le bouton plus jaune).
- Remplissez les champs décrits ci-dessous.
- Lorsque vous avez terminé, cliquez sur Ajouter.
What, When, and Scope
- What : Sélectionnez Appeler un webhook.
- When : Sélectionnez l'événement qui doit activer le déclencheur (par exemple, lorsqu'une commande de produit est terminée, ou lorsqu'un problème est signalé). Les événements disponibles dépendent de l'étendue.
- Scope : Choisissez à quoi s'applique le déclencheur - par exemple une catégorie d'article, toutes les commandes de produits, les problèmes, les audits ou un tableau. Les événements disponibles dépendent de l'étendue. Consultez :
Vous pouvez ultérieurement modifier ou supprimer le déclencheur, et consulter l'historique d'utilisation.
Attributs
Après avoir sélectionné What et When, la section Attributs affiche les options du webhook :
-
Point de terminaison : L'URL HTTPS qu'Azumuta appellera (l'espace réservé 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.
- Charge utile : Affichée uniquement lorsque la méthode est POST. Entrez le contenu du corps personnalisé ici. La remarque de l'interface utilisateur se lit comme suit : « Vous pouvez utiliser des paramètres dans ce champ ».
Ce qu'Azumuta envoie
Azumuta inclut toujours une apiKey provenant d'un Appareil API de l'espace de travail, plus des champs spécifiques à l'événement :
| Étendue | Champs typiques |
|---|---|
| Commandes de produits |
identifier (numéro de commande du produit), et le cas échéant workinstructionId et recordingId
|
| Problèmes |
issueId, issueNumber (et pour certains événements, les champs de colonne/action associés) |
| Audits |
recordingId, workinstructionId, et les champs d'audit associés tels que auditNumber
|
La façon dont ces champs sont livrés 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 tant que JSON dans le corps de la demande. Si vous avez configuré une Charge utile personnalisée, ce contenu est imbriqué sous la clé
payloaddans le corps JSON (aux côtés deapiKeyet des champs d'événement ci-dessus).
Votre système récepteur peut utiliser la apiKey incluse pour appeler l'API REST d'Azumuta afin d'obtenir des données supplémentaires si nécessaire - un modèle courant avec une couche d'intégration devant un ERP.
Articles connexes
- Qu'est-ce qu'un déclencheur ?
- Modifier et supprimer un déclencheur
- Créer et gérer les clés API
- API REST d'Azumuta
- Intégration ERP
Remarque : L'article What's New Configurable JSON Body When Using Webhooks a annoncé historiquement la fonctionnalité de charge utile POST. Cette page est le guide pratique actuel pour configurer les déclencheurs webhook.