Dynamic Webhooks

Overview

This solution allows webhook events to be dynamically routed to multiple paths within the same base domain, providing enhanced flexibility for handling event-driven workflows.

Key Benefits

Dynamic Webhook Callbacks: Easily define custom callback paths at runtime to suit your integration needs.

Technical Implementation

1. Specifying the Callback URI: During the initial POST Create Verification Session API call, include the full callback URI to indicate where the webhook event should be sent.
2. Webhook Event Delivery: Webhook events will be routed to the specified path provided in the POST API call, ensuring precise delivery to your endpoint.
3. Finalizing the Process: After receiving the webhook event, complete the GET API call to retrieve and process the final verification details, completing the workflow seamlessly.

Example Request

curl --request POST \
  --url https://verified.clearme.com/v1/verification_sessions \
  --header 'accept: application/json' \
  --header 'content-type: application/json'
  --data '{
 	 	"project_id": "project_xyz",
  	"callback_url": "https://www.example.com/clear_event?uuid=9d7f4c4f-d110-42f8-82e1-33a56bf1fbac",
  	"callback_headers": {
     		"Authorization": "Bearer xyx"
  	   }
}'

The base domain must still be registered on the CLEAR dashboard along with all relevant events selected.