Webhooks

WebHooks are a mechanism for notifying the system about events. For example, when an event occurs in KOMPaaS, the webhook requests the address and parameters of the event, then sends them to a third-party application.

Typically, "custom HTTP callbacks" are triggered by some event, such as transferring a call to another internal subscriber or an incoming call to the Virtual PBX. When this event occurs, the originating site sends an HTTP request to the URL specified for the webhook. Users can configure them so that events on one site trigger actions on another.

The most common types of events for which you can create a webhook are:

• Telephony calls (incoming, outgoing, call answered, start/end of call, etc.)
• VPBX calls;
• Authorization calls (Password Call, Flash Call, etc.);
• SMS;
• Calltracking;
• Automated calls;

The full list of events can be viewed in the webhook creation window. When created, the webhook subscribes to the desired event, and when the event occurs, it sends a request to the specified address.

To view the webhook activation history, hover your mouse over the webhook status.

For more details on request types see:

'POST request'

'GET request'