ALERT: Webhook

Modified on Wed, Sep 17 at 3:49 PM

Webhook is a user-defined HTTP callback that allows one system or application to send real-time data to another system or application as soon as an event occurs.

Instead of the traditional polling mechanism where one system repeatedly checks another for updates, a webhook enables real-time data delivery.

Webhook URL, username, password, header key, and header value data will vary depending the exact webhook/system you are using. If you need help on your specific integration setup, please get in touch with our support team by emailing to support@connectsecure.com and provide the details and system(s) used.

Overview
Getting Started
Setup
Get Support

Overview

This integration allows you to send data to your webhook based on the Event Sets and Integration Rules that are defined and mapped to a company.

For a full listing of the available Event Set alerting options, see Event Sets for Integration Alerting.

Getting Started

Navigate to Global > Settings > Integrations and tap on the Webhook tile.

Setup

Credentials

You need to provide the required details as shown below.

Field Label	Description
Name	A name of your choosing, to describe the webhook
Webhook URL	The main URL of the webhook; should include https://
Webhook Authentication URL	The authentication URL; should include https://
Webhook Username	Username
Webhook Password	Password
Authentication Header Key	The `header_key` defines the name of the header (e.g., `Authorization`, `X-API-Key`).
Authentication Header Value	The `header_value` contains the credential or token used for authentication. These headers are added to the request at runtime and must be validated by the receiving service.
Selected Associated Companies	Select the ConnectSecure company or companies to use the webhook integration

Event Set

You will not see the Event Set, Integration Rules, or Company Mapping options until you have successfully saved and authenticated the webhook Credentials tab.

This is where you tell the integration what events should generate an alert. Tap the Add button to view and add your desired event sets.

Give the Event Set a name of your choosing, select a Notify By option, and select the Event Set(s) you want to create the alert(s) for.

Tap on the Category name (expand style menu) to see the individual Event Sets based on Category.

Use the checkboxes to select the Event Sets, then tap the Save button. Upon doing so, you will be prompted with a Confirmation box asking if you want to create an Integration Profile or save your event set.