Intelliprint
Browse docs

Technical

Webhooks

The Intelliprint API provides webhooks for various events that happen during the life of a print job.

On this page

Webhooks allow you to receive near real-time HTTP notifications when events occur in your Intelliprint account, such as when letters are printed, dispatched, delivered, or returned.

Available Webhook Events

Event
letter.updated
Description
A letter has been updated. This is triggered when a letter is printed, dispatched, delivered, or returned.
Event
mailing_list.addresses_validated
Description
Address validation is a paid add-on service offered by Intelliprint. This is triggered when the addresses in a mailing list are validated.

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"
}