Webhook

idstring<uuid>

namestring

descriptionstringnullable

urlstring

Example: https://erp.example.com/nuntiq/events

eventsstring[]

Possible values: [invoice.ready_for_integration, invoice.integration_result, payment.applied, inbound_file.processed, invoice.lifecycle_message, supplier.bank_details_changed, api_key.rotated, api_key.expiring]

is_activeboolean

organization_codesstring[]nullable

Limited to these organizations (from the creating key's scope)

created_bystring

created_atstring<date-time>

updated_atstring<date-time>

last_success_atstring<date-time>nullable

last_failure_atstring<date-time>nullable

consecutive_failuresinteger

previous_secret_expires_atstring<date-time>nullable

After a secret rotation: until when the previous secret also signs deliveries

secretstring

Only in the answer to create and to rotate_secret: whsec_...

Webhook

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "description": "string",
  "url": "https://erp.example.com/nuntiq/events",
  "events": [
    "invoice.ready_for_integration"
  ],
  "is_active": true,
  "organization_codes": [
    "string"
  ],
  "created_by": "string",
  "created_at": "2024-07-29T15:51:28.071Z",
  "updated_at": "2024-07-29T15:51:28.071Z",
  "last_success_at": "2024-07-29T15:51:28.071Z",
  "last_failure_at": "2024-07-29T15:51:28.071Z",
  "consecutive_failures": 0,
  "previous_secret_expires_at": "2024-07-29T15:51:28.071Z",
  "secret": "string"
}