...

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 in a table below.

  2. Create a webhook endpoint as an 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. Contact Ondato support team to register the publicly accessible HTTPS URL and a list of events you want to monitor.

Please note that we also support multiple URLs for sending webhooks.

...

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:

    1. basic - username, password.

    2. oAuth2 - clientID, clientSecret, tokenUrl.

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

Code Block
languagejson
{
	"idId": "45a51829-965c-49ac-8fbb-940aa3d8486f",
	"applicationIdApplicationId": "d73da14e-a6b9-4bb1-b9df-f3b40ba1ed34",
	"createdUtcCreatedUtc": "2022-07-26T07:16:41.873Z",
	"payloadPayload": {
		"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"
	},
	"typeType": "Form.Created"

Events
Anchor
Events
Events

...