Opmerking: Dit is een zeer technisch artikel. Daarom raden we aan uw IT-afdeling erbij te betrekken bij het lezen hiervan. Mocht u vragen of verzoeken hebben, neem dan contact met ons op via support@azumuta.com - we helpen u graag.
Wanneer Azumuta een ander systeem moet melden dat er iets is gebeurd (bijvoorbeeld een productorder is voltooid of een issue is gerapporteerd), geeft u de voorkeur aan een webhook trigger boven periodiek polling van de REST API. Webhooks wisselen alleen de noodzakelijke gegevens uit op het moment dat de event plaatsvindt. Voor het bredere ERP-integratiepatroon raadpleegt u ERP Integration.
Dit artikel legt uit hoe u een Een webhook oproepen 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-apparaat in uw workspace. U hebt minstens één API-apparaat nodig dat is geconfigureerd. Als er geen bestaat, mislukt de webhook met een fout zoals No api device configured.
Zie Create and manage API keys voor instructies over het instellen van een API-apparaat, en Azumuta's REST API voor hoe die sleutel wordt gebruikt wanneer u Azumuta terugbelt.
Een webhook trigger toevoegen
- Klik op Instellingen onder Management.
- Klik op Triggers onder Integraties.
- Klik op Trigger toevoegen (de gele plus-knop).
- Vul de hieronder beschreven velden in.
- Klik op Toevoegen wanneer u klaar bent.
What, When, and Scope
- What: Selecteer Een webhook oproepen.
- When: Selecteer de event die de trigger moet activeren (bijvoorbeeld wanneer een productorder is voltooid of wanneer een issue wordt gerapporteerd). Beschikbare events zijn afhankelijk van de scope.
- Scope: Kies waar de trigger op van toepassing is - bijvoorbeeld een artikelcategorie, alle productorders, issues, audits of een bord. Beschikbare events zijn afhankelijk van de scope. Zie:
U kunt de trigger later bewerken of verwijderen en de gebruiksgeschiedenis bekijken.
Attributen
Nadat u What en When hebt geselecteerd, toont de sectie Attributen de webhook-opties:
-
Endpoint: De HTTPS-URL die Azumuta zal oproepen (placeholder begint met
https://). Dit endpoint moet toegankelijk zijn vanaf de Azumuta-servers. - Method: Keuzerondjes voor GET of POST. De standaard is GET.
- Payload: Alleen weergegeven wanneer de methode POST is. Voer hier de aangepaste body-inhoud in. De UI-opmerking luidt: "Je kan parameters gebruiken in dit veld."
Wat Azumuta Stuurt
Azumuta bevat altijd een apiKey van een workspace API-apparaat, plus event-specifieke velden:
| Scope | Typische velden |
|---|---|
| Productorders |
identifier (productordernummer), en waar van toepassing workinstructionId en recordingId
|
| Issues |
issueId, issueNumber (en voor sommige events, gerelateerde kolom-/actievelden) |
| Audits |
recordingId, workinstructionId, en gerelateerde auditvelden zoals auditNumber
|
Hoe deze velden worden geleverd, hangt af van de methode:
- GET: Velden worden toegevoegd als URL-queryparameters.
-
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 bovenstaande event-velden).
Uw ontvangende systeem kan de opgenomen apiKey gebruiken om de Azumuta REST API aan te roepen voor aanvullende gegevens wanneer nodig - een veelgebruikt patroon met een integratielaag voor een ERP.
Gerelateerde artikelen
- What Is a Trigger?
- Edit and 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 gezien de POST payload-feature aan. Deze pagina is de huidige how-to voor het configureren van webhook triggers.