WebhookDeliveryDto

One event sent, or being sent, to a webhook: what was sent, how often it was tried and how the receiver answered.

Properties

Name	Type	Description
code*	string	The delivery's code (the id in the payload)
The delivery's code (the id in the payload)
webhookCode*	string	The webhook it was sent to
The webhook it was sent to
event*	enum	The event TestWebhook SubcontractorCreated SubcontractorUpdated SubcontractorDeleted SubcontractorVerified SubcontractorVerificationFailed SubcontractorVerificationRemoved InvoiceCreated InvoiceUpdated InvoiceDeleted ReturnOpened ReturnSubmitted ReturnAccepted ReturnFailed WebhookAutoDisabled
The event TestWebhook SubcontractorCreated SubcontractorUpdated SubcontractorDeleted SubcontractorVerified SubcontractorVerificationFailed SubcontractorVerificationRemoved InvoiceCreated InvoiceUpdated InvoiceDeleted ReturnOpened ReturnSubmitted ReturnAccepted ReturnFailed WebhookAutoDisabled
url*	string	The URL it was sent to
The URL it was sent to
status*	enum	Whether it is waiting, delivered, being retried or has failed Pending Success Retrying Failed
Whether it is waiting, delivered, being retried or has failed Pending Success Retrying Failed
attemptCount*	integer	How many times it has been sent
How many times it has been sent
httpStatusCode	integer	The receiver's HTTP status on the last attempt
The receiver's HTTP status on the last attempt
deliveredDate	string	When it was delivered
When it was delivered
nextRetryDate	string	When it is sent again, while it is being retried
When it is sent again, while it is being retried
createdDate*	string	When the event happened
When the event happened
payload	string	The JSON that was sent. On the single GET only.
The JSON that was sent. On the single GET only.
responseBody	string	What the receiver answered on the last attempt. On the single GET only.
What the receiver answered on the last attempt. On the single GET only.

JSON Example

{
  "code": "00000000-0000-0000-0000-000000000000",
  "webhookCode": "00000000-0000-0000-0000-000000000000",
  "event": "TestWebhook",
  "url": "string",
  "status": "Pending",
  "attemptCount": 0,
  "createdDate": "2024-01-01T00:00:00Z"
}

Used By Operations

Contained in Schemas

WebhookDeliveryDtoPagedResult