Note: This is a highly technical article. Therefore, we recommend involving your IT department when reading this. Should you have any inquiries or requests, please contact us through support@azumuta.com - we'd be happy to assist you.
When Azumuta needs to notify another system that something happened (for example, a product order was completed, or an issue was reported), prefer a webhook trigger over periodically polling the REST API. Webhooks exchange only the necessary data at the moment the event occurs. For the broader ERP integration pattern, see ERP Integration.
This article explains how to configure a Call a webhook trigger: where to set it up, which attributes to fill in, and what Azumuta sends to your endpoint.
Prerequisites
Webhook triggers include an apiKey taken from an Api Device in your workspace. You need at least one Api Device configured. If none exists, the webhook fails with an error such as No api device configured.
See How to Create and Manage API Keys for how to set up an Api Device, and Azumuta’s REST API for how that key is used when calling Azumuta back.
How to Add a Webhook Trigger
- Click on “Settings” under “Management”.
- Click on “Triggers” under “Integrations”.
- Click on “Add trigger” (the yellow plus button).
- Fill out the fields described below.
- When you’re done, click on “Add”.
What, When, and Scope
- What: Select “Call a webhook”.
- When: Select the event that should activate the trigger (for example, when a product order is completed, or when an issue is reported). Available events depend on the scope.
- Scope: Choose what the trigger applies to - for example an article category, all product orders, issues, audits, or a board. Available events depend on the scope. See:
You can later edit or delete the trigger, and review usage history.
Attributes
After you select What and When, the Attributes section shows the webhook options:
-
Endpoint: The HTTPS URL Azumuta will call (placeholder starts with
https://). This endpoint must be accessible from the Azumuta servers. - Method: Radio buttons for GET or POST. The default is GET.
- Payload: Shown only when the method is POST. Enter the custom body content here. The UI note reads: “You can use parameters in this field.”
What Azumuta Sends
Azumuta always includes an apiKey from a workspace Api Device, plus event-specific fields:
| 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
|
How those fields are delivered depends on the method:
- GET: Fields are added as URL query parameters.
-
POST: Fields are sent as JSON in the request body. If you configured a custom Payload, that content is nested under the key
payloadin the JSON body (alongsideapiKeyand the event fields above).
Your receiving system can use the included apiKey to call the Azumuta REST API for additional data when needed - a common pattern with an integration layer in front of an ERP.
Related Articles
- What Is a Trigger?
- How to Edit an Delete a Trigger
- How to Create and Manage API Keys
- Azumuta’s REST API
- ERP Integration
Note: The What’s New article Configurable JSON Body When Using Webhooks announced the POST payload feature historically. This page is the current how-to for configuring webhook triggers.