Webhooks in Alumio

Alumio_Bot · October 4, 2022, 1:47pm

Introduction

Webhooks enable external applications to send data to Alumio in real-time. A webhook configuration enables an API endpoint for another application to connect to.

Webhooks can be created and maintained by navigating to Connections → Webhooks.

Creating and maintaining webhooks

Possible configuration fields:

Name - A name describing data this configuration processes, i.e. ERP Stock
Identifier - A unique identifier for this webhook (this field is automatically generated based on the name).
Description - Detailed description for the webhook.
Disabled - A flag that indicates whether the webhook configuration is disabled. Disabled webhook configurations do not process data.
Incoming configuration - The incoming configuration where the incoming data should be forwarded to.
Additional incoming configurations - In some cases it is desired to forward the incoming data to multiple incoming configurations. An example would be a system that is limited to sending all mutations to any entity to only one webhook. You may want to route each entity towards another system and/or endpoint. By creating a separate incoming configuration per each entity, you are offered the flexibility of only routing the relevant entities.
Enable logging - Enables logging for all requests made to the webhook.
Pre-processors - Pre-processors may be used to validate the request is coming from a legitimate source. An example would be a custom header with a common secret, used by both parties to validate the legitimacy of a request.
Post-processors - The post-processors are executed after the webhook has been consumed and tasks have been created.

Using a webhook

To make use of a webhook you need to share your Alumio environment’s webhook base URL, as well as the relevant identifier. Depending on the settings of your webhook you may also need to share any request validators.

The webhook base URL can be found on the Info page under Settings → Info.

It’s also possible to add additional paths in the Webhook URL to expand extra variables when there is a need to change some paths.
To do that, use the following steps:
Step 1: Create a new webhook and make it part of a full route.
Step 2: Add a scheduler to run the route.
Step 3: Use a tool like Postman to send data to the webhook and verify tasks are created and are processed correctly.
Step 4: Use the default webhook URL and try adding additional path variables.
Compare webhook variables in the Export and Import messages tab of Tasks.

Using the header data in the Webhook incoming request

When users want to utilise header data from incoming webhook requests to support multiple sources through a single webhook, they can use the header data from an incoming webhook request.

Step 1: Create a new Incoming configuration and select the Webhook as a Subscriber.

Step 2: Select parser as Plain text. At the bottom of the page, the “Add headers” checkbox will be displayed, allowing you to use the header data.

Step 3: Input the rest of the mandatory fields and run the process.

Alerts in Webhooks

Alumio supports alerts and enhanced logging for Webhooks to improve error visibility and response time. Users can receive notifications when tasks fail, configure alert recipients, and access detailed logs, making it easier to identify issues and take timely action.

Follow this guide to know how to interact with Webhook alerts.

Step 1: Navigate to Connections → Webhook.

Step 2: Create a new Webhook or go to the existing one from the overview page.

Step 3: On the Webhook details page, you can see a list of tabs. To set an alert for the corresponding configuration, select the “Alerts” tab.

Step 4: Click on the “Create” button and select a proper condition from the popup.