Models
Document Delivery
Properties
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The delivery ID. It identifies this delivery in document.delivery_status_changed webhook events. Example: "dlv_01JQZ8X0M4T7RB6K9V2NDHW3PA" |
channel | peppol | email | Yes | How the document was sent to this address. Example: "peppol". Values: peppol, email |
address | string | Yes | The Peppol address or email address the document was sent to. Example: "0208:0428643097" |
status | pending | delivered | failed | Yes | pending: the channel accepted the document and has not confirmed arrival. delivered: the channel confirmed arrival; for Peppol the recipient's access point acknowledged the document, for email the recipient's mail server accepted the message. failed: the document did not arrive; for email the message bounced or was refused. See failure. Example: "delivered". Values: pending, delivered, failed |
statusChangedAt | string | Yes | When the delivery reached its current status |
failure | Delivery Failure | null | Yes |
references | object | Yes | The identifiers the delivery is known by on its channel: the AS4 and envelope IDs for peppol deliveries, the mail service's messageId for email deliveries |
failure (One of)
Delivery Failure:
| Name | Type | Required | Description |
|---|---|---|---|
category | recipient_not_found | document_not_supported | validation | transport | recipient_rejected | duplicate | other | Yes | Why the delivery failed, in the same terms for every channel and access point: recipient_not_found (the address is not registered on the network, or the mailbox does not exist), document_not_supported (the recipient does not receive this document type), validation (the document was refused by a rule), transport (it could not be transmitted, or the mail server did not take the message), recipient_rejected (the recipient or their server refused it, for email a block or spam complaint), duplicate or other. Example: "validation". Values: recipient_not_found, document_not_supported, validation, transport, recipient_rejected, duplicate, other |
message | string | null | Yes | What went wrong, as the channel or access point described it |
providerCode | string | null | Yes | The access point's or mail service's own code for the failure, when it reported one: an access point error code, or a bounce type such as HardBounce. Example: "TXE-1005" |
references properties
| Name | Type | Required | Description |
|---|---|---|---|
peppolMessageId | string | null | No | The AS4 message ID of the transmission |
peppolConversationId | string | null | No | The AS4 conversation ID of the transmission |
envelopeId | string | null | No | The envelope ID (SBDH instance identifier) of the transmission |
messageId | string | null | No | The mail service's message ID of the email, for email deliveries. It is the ID a bounce or delivery notification from the mail service refers to. Null when the delivery predates message tracking |