gitlabEdit

๐Ÿ“ฎPostal Events

Webhook events for Postal service providers.

Overview

The following Postal providers support webhook notifications:

  • Mysendingbox

Mysendingbox Events

Events

letter_created

Letter was created and queued

Payload Example:

{
  "event": "letter_created",
  "timestamp": "2026-02-13T12:30:00Z",
  "dispatchId": "disp_abc123",
  "provider": "mysendingbox",
  "service": "postal",
  "data": {
    "letterId": "letter_abc123",
    "status": "delivered",
    "trackingNumber": "TRACK123456",
    "deliveredAt": "2026-02-15T10:00:00Z"
  }
}

letter_in_transit

Letter is in transit to recipient

Payload Example:

letter_delivered

Letter was delivered

Payload Example:

letter_failed

Letter delivery failed

Payload Example:

letter_returned

Letter was returned to sender

Payload Example:

Webhook URL

Configure this URL in Mysendingbox dashboard:

Handler Example (Node.js)

Best Practices

1. Respond Quickly

Always return 200 OK within 5 seconds:

2. Verify Signatures

Always verify webhook signatures to prevent spoofing:

3. Handle Idempotency

Webhooks may be delivered multiple times - use idempotency:

Next Steps

Last updated