Een webhook aanroepen vanuit een trigger
Opmerking: Dit artikel is technisch van aard; wij raden aan iemand met de juiste technische kennis erbij te betrekken. Als u vragen heeft, neem contact op met support@azumuta.com.
Wanneer Azumuta een ander systeem moet informeren dat er iets is gebeurd (bijvoorbeeld wanneer een productorder is voltooid of wanneer een issue is gemeld), heeft u de voorkeur aan een webhook-trigger boven het periodiek pingen van de REST API. Webhooks wisselen alleen de noodzakelijke gegevens uit op het moment dat het evenement plaatsvindt. Voor het bredere ERP-integratiepatroon, zie ERP Integration.
Dit artikel legt uit hoe u een Call a webhook-trigger configureert: waar u deze instelt, welke attributen u moet invullen en wat Azumuta naar uw endpoint stuurt.
Vereisten
Webhook-triggers bevatten een apiKey afkomstig van een Api Device in uw workspace. U moet ten minste één Api Device geconfigureerd hebben. Als er geen bestaat, faalt de webhook met een fout zoals No api device configured.
Zie Create and manage API keys voor hoe u een Api Device instelt, en Azumuta’s REST API voor hoe die sleutel wordt gebruikt wanneer Azumuta contact met u opneemt.
Een webhook-trigger toevoegen
- Klik Instellingen onder Beheer.
- Klik Triggers onder Integrations.
- Klik Trigger toevoegen (de gele plusknop).
- Vul de hieronder beschreven velden in.
- Als u klaar bent, klik op Toevoegen.
Wat, Wanneer en Scope
- Wat: Selecteer Call a webhook.
- Wanneer: Selecteer het evenement dat de trigger moet activeren (bijvoorbeeld wanneer een productorder is voltooid of wanneer een issue wordt gemeld). Beschikbare evenementen hangen af van de scope.
- Scope: Kies waarop de trigger van toepassing is — bijvoorbeeld een artikelcategorie, alle productorders, issues, audits of een board. Beschikbare evenementen hangen af van de scope. Zie:
U kunt later bewerken of verwijderen van de trigger en de gebruiksgeschiedenis bekijken.
Attributen
Nadat u Wat en Wanneer heeft geselecteerd, toont de sectie Attributen de webhook-opties:
- Endpoint: De HTTPS-URL die Azumuta zal aanroepen (placeholder begint met
https://). Deze endpoint moet bereikbaar zijn vanaf de Azumuta-servers. - Method: Keuzerondjes voor GET of POST. Standaard is GET.
- Payload: Alleen zichtbaar wanneer de methode POST is. Voer hier de aangepaste inhoud van de body in. De UI-opmerking luidt: "U kunt parameters in dit veld gebruiken."
Wat Azumuta stuurt
Azumuta stuurt altijd een apiKey van een workspace Api Device mee, plus evenement-specifieke velden:
| Scope | Typical fields |
|---|---|
| Product orders | identifier (product order number), and when applicable workinstructionId and recordingId |
| Issues | issueId, issueNumber (and for some events, related column/action fields) |
| Audits | recordingId, workinstructionId, and related audit fields such as auditNumber |
Hoe deze velden worden geleverd hangt af van de methode:
- GET: Velden worden toegevoegd als URL query parameters.
- POST: Velden worden als JSON in de request-body verzonden. Als u een aangepaste Payload hebt geconfigureerd, wordt die inhoud genest onder de sleutel
payloadin de JSON-body (naastapiKeyen de hierboven genoemde evenementvelden).
Uw ontvangende systeem kan de meegeleverde apiKey gebruiken om de Azumuta REST API aan te roepen voor aanvullende gegevens indien nodig — een veelvoorkomend patroon met een integratielaag voor een ERP.
Gerelateerde artikelen
- Create a Trigger
- Edit or delete a trigger
- Create and manage API keys
- Azumuta’s REST API
- ERP Integration
Opmerking: Het What’s New-artikel Configurable JSON Body When Using Webhooks kondigde historisch de POST-payloadfunctie aan. Deze pagina is de actuele how-to voor het configureren van webhook-triggers.