Define Validation-Request Handling for a Trigger

Learn how to handle the validation requests from external applications during the webhook registration process.

For complete information on validation requests during the registration process, see Validation During Webhook Registration.

As a first step, you must identify the validation-request contract from the external application. Additionally, for this example, we'll assume the following:

The validation request includes the header event-type with the value SubscriptionValidation.
The JSON payload includes the validation code.
Oracle Integration returns a 200 OK response with the validation code.

In VS Code, click Explorer on the sidebar.
The directory structure of your workspace folder is displayed.
Within the definitions directory listing, click the adapter definition document that you want to work on.
The document is displayed in the VS Code editor.
In the triggers section of the document, define a pass-through trigger. See Define a Pass-Through Trigger.

Add a validationRequests block to the trigger code.

Sample code for validationRequests:

"validationRequests": [{
            "condition": "${.request.headers.\"event-type\"==\"SubscriptionValidation\"}",
             "response": { 
                 "status": 200,
                "body": {
                    "validationResponse": "${.request.body.validationCode}"
                }
      }
],

Sample code for a trigger with validation-request handling:

"triggers":{
   "pageChangeEvent": {
      "displayName": "Wiki Page Updated Event",
      "description": "This trigger detects when a Wiki Page Updated Event is raised.",
      "type": "webhook",
      "httpMethod": "POST",
      "request": {
        "schemaType": "application/schema+json",
        "schema": {
          "$ref": "#/schemas/eventSchema"
        }
      },
     "validationRequests": [{
            "condition": "${.request.headers.\"event-type\"==\"SubscriptionValidation\"}",
             "response": { 
                 "status": 200,
                "body": {
                    "validationResponse": "${.request.body.validationCode}"
                }
      }
     ]
    }
}