Webhooks

sharing_request:submitted

An applicant submitted data against a sharing request.

postWebhookSharingRequestSubmitted

Headers

X-Akahu-Apply-Signaturestring required

Detached JWS over the request body, signed with ES256. The signing key is published at https://api.apply.akahu.nz/.well-known/jwks.json

Example:eyJhbGciOiJFUzI1NiIsImtpZCI6IjAwMDAwMDAwLTAwMDAtNDAwMC04MDAwLTAwMDAwMDAwMDAwMCJ9..c2lnbmF0dXJl

X-Akahu-Apply-Request-Idstring required

Unique per delivery attempt, including retries. Quote it when asking us about a delivery. Not an idempotency key - use the event _id for that.

Example:00000000-0000-4000-8000-000000000000

Payload

_idstring required

emitted_atstring date-time required

Example payload

{
  "_id": "evt_tz4a98xxat96iws9zmbrgj3a",
  "payload": {
    "_org": "org_tz4a98xxat96iws9zmbrgj3a",
    "_application": "application_tz4a98xxat96iws9zmbrgj3a",
    "_sharing_request": "sharing_request_tz4a98xxat96iws9zmbrgj3a"
  }
}

Response

Event acknowledged.

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.