TABLE OF CONTENTS
- Getting Started With The Webhook Page
- How Can You Create A New Web Hook?
- Closing Note
Webhooks facilitate external applications to transmit data to Alumio in real-time. Alumio is a proven iPaaS platform that supports integration efforts worldwide and as such, it comes with a Webhook set-up page that allows you to tweak it as per requirements. This article will provide you with an in-depth knowledge of the Alumio Webhook Page in detail.
Getting Started With The Webhook Page
To begin with, Webhooks can be created and sustained by simply navigating to Connections -> Webhooks in Alumio.
You can see all the tabs that you will also find in many of the other Alumio pages such as:
Name: It lists the Webhooks by their names.
Description: It reflects a short description for the webhooks (if specified by a user).
Created at: As the name suggests, it reflects the time at which a specific web hook was created.
Updated at: As the name suggests, it reflects the time at which a specific web hook was updated.
Actions: It allows the users to do some actions on the web hooks such as Export, Copy URL, Duplicate or Delete.
In addition to them, there is an array of useful search filters in the Webhook Overview Page of Alumio such as Name, Created At, Updated At, and Add Filter +, that paves the way for a varied range of search functionalities.
How Can You Create A New Web Hook?
Here is an easy guide for you to create the web hook pages!
Step 1: Lying to the left of the Pagination button, there is a + button, using which, you can create new webhooks. Click on the + button.
Step 2: There are certain configuration fields in the webhook page that you need to fill up in the webhook set-up page. They are:
Name - Enter a name that describes the webhook neatly. For instance, you can name it Webhook To System B.
Identifier - This field denotes a unique identifier for this webhook.
Note: This field is automatically generated based on the name).
Description - You can provide a detailed description of the webhook in this field.
Status - This is a flag that indicates whether the webhook configuration is disabled or enabled. In case the webhook configurations are disabled, they will not process data.
Incoming Configuration - The incoming configuration (which will be connected to a route) is where the incoming data must be forwarded to. You can select it from the drop-down menu.
Note: Chronologically, a web hook does the following things in Alumio. It picks up the data and provides an immediate response to the system through efficient data handling from the web surface. While you can opt for a default response, it is also possible to create a custom response for the data.
Additional Incoming Configurations- In some scenarios, you might have to forward the incoming data to multiple incoming configurations. You can also Enable logging if you wish to.
Enable logging - It enables logging for all requests made to the webhook.
Pre-processors - Similar to the HTTP proxies page, you can use pre-processors and Request Validators within it. They can validate the webhook request (whether or not it is coming from a legitimate source) if you implement a Matcher.
You can select a matcher from the drop-down menu such as All Matched, Method Matcher, Header Matcher, etc. For example, you can utilize a Header Matcher with a specified Header Name and Pattern. You can also specify a HTTP status code when no match happens along with a field for Message when no match. The best part is that you can add as many Matchers as you want and they will all work in tandem.
Post-processors - The post-processors are executed after the webhook has been consumed and tasks have been created. Similar to pre-processors, you can add Request Validators within it.
Note: There is no scope to add Entity transformers in the web hook setup page. This is because those transformers are present within the Incoming configuration (that the webhook is feeding to), or the Route, or the Outgoing configuration.
Step 3: When you have finished configuring the webhook as per requirement, click on the Save & continue button at the top right corner.
Once it is saved, you can start talking to the system by copying the URL and providing its information to the Incoming configuration > Route > Outgoing configuration (System B in this case, as we named the webhook)
Step 4: You can also go to Logs and check the logs of the information that came in.
Webhooks are typically utilized to bridge two separate applications/interfaces. When an event occurs on the trigger interface, the data for the event is serialized and sent to a webhook URL from the action application. This data can then be used by you for further processing as you pass it through incoming configurations, routes, and other outgoing configurations. Alumio webhooks are easy to create and this guide has hopefully answered all your queries. Stay tuned with us to learn more!