WebhookEventDetailDto
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
One webhook delivery in full, including the body the platform posted.
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 | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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.
| ||||||||||||
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.
| ||||||||||||
httpStatusReason
required |
string | The reason phrase the endpoint sent back with its status code, when it sent one.
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.
| ||||||||||||
destinationEndpoint
required |
string | The address the platform posted 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.
| ||||||||||||
correlationId
required |
string | The platform correlation id, for a support conversation.
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.
| ||||||||||||
eventPayloadJson
required |
string | The body the platform posted, byte for byte, when the platform can confirm it; otherwise
`null`, with `eventPayloadUnavailableReason` saying why.
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.
| ||||||||||||
eventPayloadUnavailableReason
required |
WebhookEventPayloadUnavailableReason WebhookEventPayloadUnavailableReason | Why `eventPayloadJson` is withheld, or `null` whenever the body is present.
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.