Skip to main content

Overview

Webhooks are HTTP callbacks that notify your application about events on the didx:me platform, removing the need to poll the API for status updates.

Supported events

Registering a webhook endpoint

Response (201 Created)

Webhook payload structure

All webhook payloads include an eventType and a payload with a resource reference:

Technical requirements

Your webhook endpoint must:
  • Accept POST requests.
  • Use HTTPS exclusively.
  • Respond promptly with a 2xx status code.
  • Handle duplicate deliveries. The platform may retry on failure.
  • Be idempotent. Processing the same event twice should produce the same result.

Local development

Use ngrok to expose your local server via a public HTTPS URL during development:
Register the resulting https:// ngrok URL as your webhook endpoint. The platform retries failed deliveries automatically.