Webhooks

Introduction

Webhooks enable Ondato to send you real-time notifications about events happening with your Identity Verifications. Ondato uses HTTPS to send these notifications as a JSON payload.

Steps to receive webhooks

To start receiving event notifications into your application you need to go through the following steps:

1. Identify the events you want to monitor. Please see a full list of events here.

2. Create a webhook endpoint as a HTTP endpoint on your local server.

3. Handle requests from Ondato.

4. Deploy your webhook endpoint so it would be publicly accessible HTTPS URL.

5. Register the publicly accessible HTTPS URL with Ondato by contacting Ondato support team.

Requirements for webhook endpoint

Ondato needs to know where to send information about events. In order to receive webhooks you need to create a webhook endpoint and provide us with the publicly accessible HTTPS URL that would meet the following criteria:

1. URL format: https://<your-website-name>/<your-webhook-endpoint>.

2. URL must support POST HTTP Method.

3. URL must support one of the available authentication flows that you self selected when configuring subscription.

Events sent by Ondato will have a body in the following contract:

{
	"id": "45a51829-965c-49ac-8fbb-940aa3d8486f",
	"applicationId": "d73da14e-a6b9-4bb1-b9df-f3b40ba1ed34",
	"createdUtc": "2022-07-26T07:16:41.873Z",
	"payload": {
		"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
		"applicationId": "d73da14e-a6b9-4bb1-b9df-f3b40ba1ed34",
		"setup": {
			"id": "56d0b462-6f88-4725-9a7a-578c58acd85a",
			"versionId": "5c45f048-70f5-4f11-a623-b001087b78ac"
		},
		"createdUtc": "2022-07-26T07:16:40.873Z",
		"identityVerificationId": "9eae922a-00af-4e54-830b-ca6f7fe5af16",
		"status": "Unfinished"
	},
	"type": "Form.Created"

Webhook events list

Webhook events we are currently supporting: