Webhook
A webhook is a feature that automatically receives events from external monitoring services.
By registering a webhook to an alert service, you can process events from that service in real-time.
Creating a Webhook
Follow these steps to create a new webhook:
Click [Create] Button
Click the [Create] button in the top right of the webhook tab to move to the webhook creation page.
Select Webhook Plugin
Select the plugin for the external monitoring service you want to connect, then click the [Continue] button.
Enter Webhook Information
Enter the webhook’s name and version, then click the [Create] button.
Complete Webhook Creation
When creation is complete, the webhook URL will be displayed. Copy this URL and register it in the webhook settings of your external monitoring service.
Viewing Webhooks
In the webhook tab, you can check the list of currently registered webhooks. You can view the status, plugin type, and request count for each webhook.
Details
This tab shows the basic information of the webhook. The main items are as follows:
| Item | Description |
|---|---|
| Name | Name of the webhook |
| Plugin | Plugin information connected to the webhook |
| State | Current enabled state of the webhook |
| Version | Version of the webhook plugin |
| Webhook ID | Unique identifier of the webhook |
| Webhook URL | URL where the webhook receives events |
Guide
This tab briefly explains what functions the webhook performs.
Errors
This tab shows the list of errors that occurred in the webhook.
Click the [View All] button to check the detailed JSON data of the error.
Message Format
This tab is for setting the format of messages delivered through the webhook.
Click the [Edit] button to set the message format in key:value format.
By default, there are From and To fields, which define how messages will be delivered.
Managing Webhooks
You can select specific webhooks from the webhook list to change their status or modify/delete them.
Enable/Disable Webhook
You can enable or disable the webhook’s status. When set to disabled, it will not receive events.
Deleting Webhook
To delete a registered webhook, select the webhook to delete from the webhook list, then click the [Actions] button and select [Delete].
Modifying Webhook Name
To modify the name of a registered webhook, select the webhook to modify from the webhook list, then click the [Actions] button and select [Edit Name].
