Summary
Introduced in EngageIP 8.5.14.0
...
| Table of Contents |
|---|
Summary
Webhooks allow for external applications to listen for events that are occurring within EngageIP. They facilitate easier integration with EngageIP and remove the requirement to poll EngageIP's data, providing instant notifications of completed events. They also provide a mechanism to decouple business-specific logic and processes from the inner workings of EngageIP, allowing integrations to be developed in the language and on the platform of choice.
...
Entity Events
Entity Events tell the system what events it should capture when they occur. Whenever an Entity is Created, Updated or Deleted an event is passed through EventLogger.Log(). There, it looks at a cache of the Entity Events table to see if it should process the event or not. If the event should be handled, it creates a new WebhookActivity in the WebhookActivity table.
| Info |
|---|
Note: The dropdowns for entity events will show only if you have your AuditSettings table populated. If its not populated, in order to see the entity events you'll need request that LogiSense support populate the AuditSettings table in your database. |
Requirements
The EngageIP Webhook must be running in Windows for Webhooks to function as described above
EngageIP 9.3.2 or earlier: Domain Model Logging must be enabled (found on the Configuration page in EngageIP). This setting does not need to be enabled for systems running EngageIP 9.3.3 or later versions
Webhooks will only fire on objects that have a valid OwnerId or UserId
Configuration
| Info |
|---|
Permissions Required: In order to perform the configuration steps below the EntityEvent (Add, List) role permissions must be enabled for your EngageIP role. See the Roles - Adding Roles, Setting Role Permissions and Importing guide for instructions on adding permissions. |
Configuration File
The Configuration file for the Webhook can be found in your EngageIP install path (typically C:\Program Files(x86), under the EngageIP\Services path. The file name is WebhookService.exe.config. Within the file you can change the Queue Polling Time (default is every 5 seconds). The polling time value determines how often the Webhook Activity Table is polled.
| Info |
|---|
Note: If the WebhookService.exe.config file is renamed or missing the Queue Polling Time will execute every second. |
Creating an Entity Event
In the AdminPortal load on the Setup tab page
Click on Entity Events
Click the Add button
The Add Entity Event page will load, shown below
Select an Entity (for example UserPackage)
Select an Action (for example Update)
Enter a Description of the Event (optional)
Check Enabled5.
Click the Save button when finished, or Save/New to add another Entity Event
Registering Webhooks
| Info |
|---|
Permissions Required: In order to perform the configuration steps below the WebhookRegistration (Add, List) role permissions must be enabled for your EngageIP role. See the Roles - Adding Roles, Setting Role Permissions and Importing guide for instructions on adding permissions. |
The Webhooks needs to know what to do with WebhookActivites in queue. Webhook Registrations specify what URI to send the event to.
Load on the Setup tab page
Click Webhook Registration
On the Webhook Registration page that loads click the Add button
The Add Webhook Registration page will appear, shown below
Select an Entity/Action to handle
Enter the URI to POST to
Check Is Enabled to Enable the Registration
Check Sends Json to include JSON of the Entity, Action and the Object in the POST request
Click the Save button when finished, or Save/New to add another Webhook Registration
Webhook Activity
| Info |
|---|
Permissions Required: In order to perform the steps below the WebhookActivity (List) role permission must be enabled for your EngageIP role. See the Roles - Adding Roles, Setting Role Permissions and Importing guide for instructions on adding permissions. |
A Webhook Activity is a queued event that holds the information about an event that has occurred in the system and the request state. It contains the dates of when the event occurred, when it was last tried and when it will be tried next. It also contains information about the Entity, and the Object that was generated by the event.
Viewing Webhook Activity
Click on the Tools tab
Under the heading Tools and Utilities click on Webhook Activity
A table will display activity on the Webhook Activity page
