Webhook Integration

Purpose

This document is dedicated to providing a technical perspective on Webhook integration, highlighting its crucial role in enhancing asset monitoring within organizational settings. It offers insights into the configuration process of Webhook integration, shedding light on the parameters available for configuring the integration. The goal is to equip organizations with the technical knowledge required to efficiently leverage Webhook integration for advanced asset monitoring in their operational contexts.

Description

Webhooks are a mechanism for enabling real-time communication between web applications. They allow one application to send automated, event-driven information to another application in the form of HTTP requests. Webhooks are typically used to notify or trigger actions in response to specific events or updates.

Here's an overview of what a Webhook is and what Webhook integration can do:

Real-time Event Notification: Webhooks provide a way for applications to instantly notify other systems about events or updates. For instance, when a security event is detected, such as an attempted intrusion or a malware outbreak, a webhook can be employed to immediately notify the incident response team, triggering real-time investigation and mitigation efforts.
Automation and Integration: Webhook integration allows organizations to automate processes by connecting different software applications and services. This integration streamlines workflows, reducing manual effort and minimizing the risk of errors. For instance, a security information and event management (SIEM) system can use a webhook to automatically enrich security event data with threat intelligence feeds, enhancing its ability to correlate and analyze potential threats in real-time.
Customization and Flexibility: Webhooks are highly customizable. Organizations can define which events trigger webhooks and how they respond to those events. This flexibility enables tailored solutions for various use cases, such as sending notifications, updating databases, or executing specific tasks.
Versatile Communication: Webhooks can be used for various types of communication, including data synchronization, status updates, or triggering actions. This versatility allows organizations to create dynamic, event-driven interactions between different systems.
Real-time Analytics and Monitoring: With Webhook integration, organizations can set up real-time analytics and monitoring systems. For example, a monitoring tool can receive webhooks from various servers and services, enabling immediate detection of issues or anomalies.
Improved User Experience: Webhooks can enhance the user experience by providing timely updates and notifications. For instance, a messaging application can use webhooks to deliver instant notifications of new messages or updates.
Ecosystem Connectivity: Webhooks facilitate connectivity within an ecosystem of applications and services. They enable third-party developers to extend the functionality of an application by integrating it with other tools and platforms through webhooks.
Event-driven Actions: Webhook integration allows organizations to trigger specific actions based on external events. For example, a network security system can automatically isolate a compromised device from the network as soon as it receives a webhook notification indicating suspicious or malicious activity detected by an intrusion detection system (IDS).

In summary, Webhooks are a powerful tool for real-time communication and automation in the digital landscape. Webhook integration empowers organizations to create dynamic, event-driven workflows, improve efficiency, and enhance user experiences by connecting and automating processes across various applications and services.

Add Webhook Integration

To add a new integration, follow these steps:

Click on the green button located in the lower-right corner of the browser window.
Select the desired integration configuration type from the drop-down menu.
Fill in the necessary parameters. See Webhook fields overview.
Click Add to finish creating the Webhook integration.

Webhook Fields Overview

Option	Description
Integration	The selected integration type determines the available fields, which vary based on the chosen integration.
Name*	Descriptive name of the integration.
URL*	Represents the web address where Webhook data is sent when specific events occur, facilitating communication between systems or applications.
Retry Interval	Time duration between consecutive retry attempts that the system makes when there are difficulties in delivering Webhook payloads to the designated endpoint, influencing the timing of retry operations to optimize delivery reliability. Expressed in seconds.
HTTP Method	HTTP protocol method (e.g., POST, GET, PUT) used for sending Webhook payloads to the specified endpoint, determining the action to be performed when communicating with the remote host. When left empty it defaults to POST method.
HTTP Headers	Additional information or metadata provided within the HTTP request that accompanies Webhook payloads, conveying details about the data being transmitted and facilitating proper communication and processing between sender and recipient system.
Password*	Confidential authentication key or secret used in combination with the Username to verify the sender's identity when making HTTP requests to the Webhook endpoint.
Upload certificate	Digital security credential, often self-signed, that is used to establish a secure and trusted connection between the sender and the recipient of Webhook data, ensuring data integrity and confidentiality during transmission.
Content Sample	Represents a content sample of Webhook data is used to verify the Webhook integration works.

Edit Webhook Integration

To configure the authentication method or upload a certificate for a host that employs a self-signed certificate, you must edit the created integration and provide additional details.

Authentication Types

None

When the None authentication type is chosen for a selected webhook integration, it is possible to upload a self-signed certificate, which must be in PEM format.

Basic

Similar to the None integration, this authentication method allows for uploading of a self-signed certificate in PEM format. Additionally, two more fields are present:

Username: The credential used in the Basic authentication context when communicating with the configured host.
Password: The corresponding password for the provided username in the Basic authentication context.

Webhook Integration OAuth

For information, see Webhook Integration with OAuth v2 document.