The API reference isn't available right now
This instance couldn't load its API specification. The reference returns as soon as the specification is readable again.
Back to the API reference
No such model
This instance publishes no model under that name. It may have been renamed, or no operation this installation serves uses it.
Back to the API reference
This reference may be out of date
This instance couldn't reach its API specification on the last attempt, so this page shows the copy fetched before that. Anything added or changed since then is missing here, and the reference updates itself as soon as the specification is readable again. Last fetched 2026-10-22 22:52 UTC.
API reference
/
Models
WebhookEventPageDtoA model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
One page of webhook deliveries, plus the token that fetches the page after it.
Values
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Fields
Field
Type
Description items
required array of WebhookEventDto
array of WebhookEventDto The deliveries on this page, newest first.
nullable Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Fields of each WebhookEventDto:
Field
Type
Description id
required string (uuid)
The delivery's id, which is what the detail read takes.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
eventType
required string
The event type that was delivered, for example `transaction.created`.
nullable Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
eventId
required string
The envelope event id, which is what deduplicates a redelivery.
nullable Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
occurredAtUtc
required string (date-time)
When the originating event happened, in UTC.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
lastAttemptUtc
required string (date-time)
When the most recent attempt ran, in UTC, or `null` before the first.
nullable Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
status
required DeliveryStatus
DeliveryStatus Where the delivery got to.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
PendingDelivery work item created but not yet picked up by a processor. ProcessingDelivery is currently being processed (in-flight). SucceededDelivery completed successfully. The destination acknowledged receipt. FailedDelivery failed but may be retried. Check AttemptCount and LastError for details. DeadLetteredDelivery exhausted all retry attempts and has been moved to the dead letter queue. Requires manual investigation. SkippedDelivery was skipped (not attempted) due to kill switch, disabled destination, or other policy reason. Check SkipReason for details.
attemptCount
required integer (int32)
How many attempts have run.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
durationMs
required integer (int64)
How long the most recent attempt took, or `null` when none has run.
nullable Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
httpStatusCode
required integer (int32)
The status code the endpoint answered with, or `null` when it never answered.
nullable Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
destinationName
required string
The merchant's own name for the destination the delivery was addressed to.
nullable Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
relatedEntityType
required string
The kind of record the event was about, for example `Transaction`, or `null` when the
delivery carries no such reference.
nullable Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
relatedEntityId
required string (uuid)
The id of the record `relatedEntityType` names, or `null` when the delivery
carries no such reference.
nullable Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
This body has no documented fields.
continuationToken
required string
The token that fetches the next page, or `null` at the end.
nullable Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
This model has no documented fields.
Next steps