Webhooks
A webhook is a mechanism that allows one system or application to send real-time data to another system or application as soon as an event occurs. It is a way for applications to communicate with each other automatically. Unlike traditional APIs where one system periodically requests information from another, webhooks enable real-time data transmission.
AIForged allows users to add webhooks to their custom code to integrate with other external systems.
How to create webhooks
AIForged contains a Webhook Utility Service that can be added to any existing Service.
- Create a new Project or select an existing one.
- Create a new Service of any type or select an existing one.
Once in the Service, select the Add Utility button.
 (4).png)
In the Utilities section, select the WebHook Utility Service.
 (8).png)
- Once the Utility Service is added, the user can now configure the WebHook Service.
Configuring a WebHook Service
The following settings are available to configure a WebHook Service. These setting can be used to setup the conditions when a webhook should fire.
 (1) (2).png)
The following Document options are available.
 (2).png)
The following WebHook options are avaiable.
.png)
Custom Code Invocation
A WebHook Service can be invoked via Custom Code. The BaseModule provides the following method to invoke a WebHook Service.
| Method Name | Description | Returns |
|---|---|---|
CallWebHookAsync( IDocument srcdoc, IDocument masterdoc = null, IDocumentParameter par = null, IParameterDef def = null, IVerification verification = null, IWorkItem wi = null, int? webHookServiceId = null) | Calls a webhook service to post data to an external system. | The webhook call result. |