Configuring Webhooks

These actions require the Configure Webhooks permission.

A webhook is a mechanism that allows one system to automatically notify another when a specific event occurs, rather than requiring the receiving system to repeatedly query for updates.

When a defined event takes place in the source system - such as a completed transaction, a status change, or a new record being created - it immediately dispatches an HTTP request to a pre-configured URL in the destination system, known as an endpoint.

That request carries a payload containing the relevant event data, which the receiving system can then process and act upon in near real time.

This event-driven approach eliminates the need for constant polling, resulting in faster integrations, reduced unnecessary network traffic, and a more responsive flow of information between systems.

GAP supports webhooks for the following data types:

• Devices

• Users

• MO Messages

• MT Messages

• Tenants

For more information on working with Webhooks programmatically, see Webhooks.

Adding Webhooks

1. From the GAP Admin home page, click "Webhooks" under the "Integrations" section.

2. Select an authentication mechanism for the webhook using the "Authentication" drop-down list.

3. If using basic authentication, enter the user name and password for the endpoint in the "Username" and "Password" text boxes respectively.

4. Enter the endpoint URL in the "Webhook URL" text box.

5. Select the data types for which you want to receive notifications using the checkboxes.

6. Click the "Submit" button.

Editing Webhooks

1. From the GAP Admin home page, click "Webhooks" under the "Integrations" section.

2. To change the authentication mechanism. select from the "Authentication" drop-down list.

3. If using basic authentication, enter the user name and password for the endpoint in the "Username" and "Password" text boxes respectively.

4. To change the endpoint URL, update the value in the "Webhook URL" text box.

5. To change the data types for which you want to receive notifications, amend the checkboxes below.

6. Click the "Submit" button.

Deleting Webhooks

1. From the GAP Admin home page, click "Webhooks" under the "Integrations" section.

2. Click the "Delete Webhook" button next to the webhook you want to delete.

3. Click the "Submit" button.