Webhooks
Overview
Section titled “Overview”nuez fires a webhook to your configured endpoint after every transfer outcome. Webhooks are signed with HMAC-SHA256 so you can verify they came from nuez.
Events
Section titled “Events”| Event | When it fires |
|---|---|
transfer.completed | Transfer executed successfully on the rail |
transfer.failed | Transfer rejected by the rail |
transfer.approved | Owner approved a pending transfer |
transfer.rejected | Owner rejected a pending transfer |
transfer.expired | Approval window timed out (5 min) |
Full event payloads are documented in Webhook events.
Configuring your endpoint
Section titled “Configuring your endpoint”In the dashboard, go to API Keys → [key name] → Webhooks. Set the URL nuez should POST to.
You get one webhook endpoint per API key. The endpoint must:
- Accept
POSTrequests - Return
2xxwithin 10 seconds - Handle duplicate deliveries idempotently (nuez retries on non-2xx)
Verifying signatures
Section titled “Verifying signatures”Every webhook includes an X-Nuez-Signature header. See Webhook signatures for the full verification implementation.