...
| Panel | ||
|---|---|---|
| ||
...
- Click "Webhook Configuration" under the Admin section.
Flow Diagram
Configure the Webhook
...
As there is no webhook registered , No Records found is displayed
To configure the webhook, click Add button on the top right corner.
Enter the details of the webhook
- Webhook Name: Input a name for the webhook, which needs to be configured.
- Select Tool: Input the tool name whose webhook needs to be configured.
- Is Event Processing : Toggle this flag if webhook is used for event processing.
- Label Name: This label name will be auto populated as soon as the user selects the tool. It should follow the nomenclature of ToolCategory:LabelName:DATA. ( Populated label name won't be editable in case of event processing and label is formed as WEBHOOKNAME_TOOLNAME_EVENT)
- Data Format: The data format which is supported, is JSON.
- MQ Channel : This field gets auto populated as soon as the webhook name is entered with a prefix “IPW_”
- Dynamic Template : This field is an alternate option of Response template .It has to be a valid JSON.
- Response Template: The response template has to be added should be in string format.
- Event Config Details : Event config json object has to be added if webhook is used for event processing.
...
Sample Time Format -Time 1. 2020-03-02T05:48:48Z (yyyy-MM-dd'T'HH:mm:ss'Z')
2. 2019-06-27T14:19:55+05:30 (yyyy-MM-dd'T'HH:mm:ssXXX)
3. 2019-06-27T14:19:55-05:30 (yyyy-MM-dd'T'HH:mm:ssXXX)
4. 2019-11-13 14:35:17 UTC (yyyy-MM-dd HH:mm:ss)
5. 2019-07-03T10:39:22+0000 (yyyy-MM-dd'T'HH:mm:ssZ)
For More formatter check https://docs.oracle.com/javase/8/docs/api/java/time/format/DateTimeFormatter.html
- Add Time Fields : This is optional field, in case you want to add more time fields and time format. The time fields included are by default not in epoch, so time format needs to be mentioned.
- Data Enrichment : This includes-
- Source property
- Key pattern
- Target property
Note: To use Derived Configuration (Insights Timex, Time Fields, Data Enrichment), please delete webhook created before 13/03/2020, and configure new.
...
| Note |
|---|
|
...
- Once webhook is configured and subscribed then any webhook event matches event name defined in event config then webhook engine run queries on the fly . If queries run successfully then MQ message is acknowledged .
- If queries have any syntax errors as well as if queries are failed due to data is not present on which query is being executed in such cases event are stored on the label defined while configuring webhook and those events will further be processed by webhook offline event processor.
Offline event processor retries missed events for the time window defined in server-config property as "eventProcessingWindowInMin":60 , if window time is elapsed then event is discarded.
Note If webhook event does not match up with event defined in event config json then MQ message is acknowledged and event is discarded.
...
Configuring webhook offline processor :
...
webhook offline processor
...
:
...
| Note |
|---|
webhook offline processor runs only if property "enableWebHookEngine":true in server-config |
...
server-config changes :
"schedulerConfigInMin":{
"offlineWebhookEventProcessingInterval":20
},
...
| Note |
|---|
Manage Webhook event processing through Schedule Task Management , Task name is WebhookOfflineEventProcessing |