Technical
Webhooks
The Intelliprint API provides webhooks for various events that happen during the life of a print job.
On this page
Webhooks send HTTP notifications to your endpoint when events occur in your Intelliprint account, such as when a letter is sent or returned.
Available Webhook Events
| Event | Description |
|---|---|
letter.updated | A letter's status has changed: for example, to sent, cancelled or returned. A delivered status is also sent a set number of days after dispatch. It is an estimate based on the postage service, not a confirmation from Royal Mail. |
mailing_list.addresses_validated | Triggered when the address checks on a mailing list are complete. |
- Event
letter.updated- Description
- A letter's status has changed: for example, to
sent,cancelledorreturned. Adeliveredstatus is also sent a set number of days after dispatch. It is an estimate based on the postage service, not a confirmation from Royal Mail.
- Event
mailing_list.addresses_validated- Description
- Triggered when the address checks on a mailing list are complete.
The letter.updated Event
Example Webhook Payload
JSON
{
"account": "acc_example",
"envelope": "c5",
"id": "ltr_example",
"postage_service": "uk_second_class",
"print_id": "print_example",
"reference": "My Print Job 1",
"returned": {
"date": 1701969673,
"reason": "Delivery Refused"
},
"shipped_date": 1701869673,
"status": "returned",
"testmode": false,
"type": "letter.updated"
}