API Docs / Operations / Webhooks / List Webhook Deliveries

List Webhook Deliveries

GET /tenants/{tenant}/webhooks/deliveries

What was sent to the tenant's webhooks, newest first, without the payloads. Filter by webhook, status, event and the dates the events happened between.

Parameters

NameTypeDescription
tenant* path string

The tenant code (the organisation's URL stub)

The tenant code (the organisation's URL stub)

status query enum

Pending Success Retrying Failed

Pending Success Retrying Failed

event query enum

TestWebhook SubcontractorCreated SubcontractorUpdated SubcontractorDeleted SubcontractorVerified SubcontractorVerificationFailed SubcontractorVerificationRemoved InvoiceCreated InvoiceUpdated InvoiceDeleted ReturnOpened ReturnSubmitted ReturnAccepted ReturnFailed WebhookAutoDisabled

TestWebhook SubcontractorCreated SubcontractorUpdated SubcontractorDeleted SubcontractorVerified SubcontractorVerificationFailed SubcontractorVerificationRemoved InvoiceCreated InvoiceUpdated InvoiceDeleted ReturnOpened ReturnSubmitted ReturnAccepted ReturnFailed WebhookAutoDisabled

fromDate query string (date-time)
toDate query string (date-time)
webhook query string (uuid)
offset query integer (int32)

Number of records to skip (default: 0). Use with limit for pagination.

Number of records to skip (default: 0). Use with limit for pagination.

limit query integer (int32)

Maximum number of records to return (default: 10, max: 50)

Maximum number of records to return (default: 10, max: 50)

sortBy query enum

Field to sort by. Valid values depend on the resource.

CreatedDate

Field to sort by. Valid values depend on the resource.

CreatedDate

sortDesc query boolean

Sort in descending order (true) or ascending order (false, default)

Sort in descending order (true) or ascending order (false, default)

Responses

400 Bad Request
application/problem+json
401 Unauthorized – Invalid or missing API key
404 Not Found
application/problem+json