Webhook

Event delivered to a registered endpoint

​

Standard Webhooks format. Headers webhook-id, webhook-timestamp and webhook-signature (v1,<base64 HMAC-SHA256(secret, id + "." + timestamp + "." + body)>). Reject timestamps older than 5 minutes. Delivery is at-least-once: de-duplicate on webhook-id. Retried with exponential backoff for 72 hours on non-2xx. Payloads are thin (IDs and status only); fetch the resource through the API for its data.

Headers

  • Integer numbers.

Body·

application/json
  • the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • Resource IDs and status, e.g. { "documentId": "doc_...", "status": "processed" }.

    Properties: 1
  • values
    • user.created
    • user.updated
    • user.deleted
    • consent.changed
    • document.processed
    • document.failed
    • interview.started
    • interview.completed

Responses

  • Acknowledged

Request Example for postevent
{
  "id": "evt_01JA...",
  "type": "user.created",
  "createdAt": "2026-11-16T17:41:55.334Z",
  "userId": "usr_01JA2Y7Q3K8V5T0N4R6M2P9XWE",
  "data": {
    "additionalProperty": "anything"
  }
}
No Body
Partner API 0.1.0-draft.3 · Draft contract · Sandbox and SDK availability require confirmation.