Webhooks deliver real-time HTTP callbacks when events occur in your AIVENTURA account — so your systems can react instantly without polling.
Supported Events
- verification.created — A new verification request was submitted
- verification.completed — All checks finished successfully
- verification.failed — One or more checks failed or need review
- consent.received — Candidate signed the consent form
- report.ready — Final report is available for download
Registering a Webhook
- Go to Settings → Webhooks in your dashboard
- Click Add endpoint
- Enter your HTTPS URL (must return 2xx within 10 seconds)
- Select the events you want to receive
- Copy the signing secret for payload verification
Payload Format
Each webhook sends a JSON body with event, data, and timestamp fields. Verify the X-AIVENTURA-Signature header using HMAC-SHA256 with your signing secret.
Retry Policy
Failed deliveries (non-2xx or timeout) are retried with exponential backoff for up to 72 hours.
Local Development
Use the AIVENTURA CLI (aiventura listen) to forward webhooks to localhost during development.