Live webinar What's new in Sodium: Information Requests, plus Q&A. Thu 19 Nov, 12 noon Information Requests + Q&A, Thu 19 Nov Reserve your place

List Webhook Deliveries

GET /tenants/{tenant}/webhooks/deliveries

What was sent to the practice's webhooks, newest first: optionally for one webhook, in one status, of one event type, created from startDate (inclusive) to endDate (exclusive), UTC instants; offset, and limit (10 by default, at most 50). Empty for a practice that has never created a webhook. 409 while webhooks are not switched on in this environment.

Requires: ViewAll on OutboundWebhooks.

Parameters

NameTypeDescription
tenant* path string

The Tenant.Code

The Tenant.Code

startDate query string (date-time)
endDate query string (date-time)
status query enum

Pending Retrying Succeeded Failed Cancelled

Pending Retrying Succeeded Failed Cancelled

eventType query string
webhookId 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)

Responses

400 Bad Request
401 Unauthorized – Invalid or missing API key
403 Forbidden – the caller lacks the permissions this endpoint requires; the detail lists every one missing
application/problem+json
409 Conflict
503 Service Unavailable