WebhookDelivery
Possible values: [pending, sending, delivered, failed, cancelled]
payload object
The JSON body Nuntiq POSTs. Headers: X-Nuntiq-Event, X-Nuntiq-Event-Id, X-Nuntiq-Delivery, X-Nuntiq-Timestamp, X-Nuntiq-Signature (t=TIMESTAMP,v1=SIGNATURE: TIMESTAMP in Unix seconds, SIGNATURE the hex HMAC-SHA256 of TIMESTAMP.RAW_BODY with the webhook's secret; after a secret rotation a second v1 signed with the previous secret follows until previous_secret_expires_at, and any matching v1 is valid). Answer 2xx within 10 seconds; anything else is retried for 24 hours. The same event_id can arrive twice: deduplicate on it.
The event id
invoice events: { invoice: {...}, result | message | reason }; payment.applied: { payment, applications }; inbound_file.processed: { upload, source_document, invoices }; supplier.bank_details_changed: { supplier, locations: [{ location_code, bank_accounts: [{ account_number_last4, ... }] }], changed_by }; api_key.rotated: { api_user_id, api_user_name, action (created | rotated | revoked), key_id, key_label, key_prefix, key_last_4, expires_at, via (portal | admin | api), replaced_key_id, replaced_key_prefix, replaced_key_grace_until }; api_key.expiring: { api_user_id, api_user_name, key_id, key_label, key_prefix, key_last_4, expires_at, days_left }
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"event_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"event_type": "string",
"status": "pending",
"attempts": 0,
"next_attempt_at": "2024-07-29T15:51:28.071Z",
"last_status_code": 0,
"last_error": "string",
"last_duration_ms": 0,
"created_at": "2024-07-29T15:51:28.071Z",
"delivered_at": "2024-07-29T15:51:28.071Z",
"payload": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "string",
"created_at": "2024-07-29T15:51:28.071Z",
"organization_code": "string",
"data": {}
}
}