Videoselfie upload webhook

An introduction to the Video Selfie Webhook

The Video Selfie Upload Webhook is triggered when the video selfie capture process is complete and the video data is successfully uploaded to the session.

Endpoint details

POST https://{your-defined-url}

Request

Below is an example of the payload that you will get when the webhook triggers

{
	"clientId": "<your_clientId>",
  "flowId" : "<your_flowId>", // the flow or configuration to which this interview belongs
  "interviewId": "<interviewId>" // the interview triggering the webhook (ie, the interview to which the video is attached)
}

If you are authenticating your webhook requests , the webhook will contain the Authorization header along with the OAuth2.0 bearer token:

Authorization: Bearer <ACCESS_TOKEN>

If you configured additional custom headers, they will be included as well.

Response

To avoid our retry policy to keep sending the same notification over and over, make sure your endpoint returns one of the following:

  • Status code 204 No content
  • Status code 200 OK with a response type application/json, for example { "success" : true }
{
	"success" : true 
}