Registering a webhook

Navigate to Webhook Configuration

• Click "Webhook Configuration" under the Admin section.

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.
• 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.
• 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.

          Sample Response Template:

           repository.name=reponame,

           head_commit.id=commitId,

           head_commit.message=message,

           head_commit.timestamp=commitTime,

           head_commit.author.name=authorName

           For the response of the webhook data, please check Annexure 1.

• Node Updation :- If the Neo4j node has to be updated ,based on the unique key, set the flag true and enter the required unique property.

• Insights TimeX : This has three fields namely -
  • Time Field : This has to be last value from key-pair of response template.
  • Epoch Time : If the time field is in epoch format mark the toggle as true.
  • Time Format : If the time field is not in epoch format, then time format has to be given.

          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)                           

• 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.