Document Mailing Tracking : Webhook
Events
check.mailing.tracking
document.mailing.tracking
Sample Payload :
{ "event": { "type": "check.mailing.tracking", "data": { "id": "RmA345KVr0egdoL", "mode": "local", "carrier": "USPS", "mailType": 1, "trackingUrl": "", "trackingCode": "123456789012345678901234567890", "trackingStatus": "delivered", "estimatedDeliveryDate": "May 19, 2024 09:19:54 AM", "trackingStatusDesc": "Phase 4c - Delivery", "updatedDate": "May 19, 2024 09:19:54 AM" }, "id": "fd367dee-8dc1-4fbc-a808-e7f935327b2e", "createdAt": "2024-06-15T07:27:05.000000Z" } }
| key | description |
|---|---|
| event.type | Type of the event (check.mailing.tracking) |
| event.data.id | ID of the check or document |
| event.data.mode | Mode of operation (sandbox or production) |
| event.data.carrier | Carrier name (USPS, FedEx) |
| event.data.mailType | Shiping type of mail , Refer to your mailingOptions API for available types. |
| event.data.trackingUrl | Link to the tracking page. |
| event.data.trackingCode | Tracking code |
| event.data.trackingStatus | Current status of the tracking ('pre_transit','in_transit','delivered','error','unknown','out_for_delivery','return_to_sender' or 'cancelled') |
| event.data.estimatedDeliveryDate | Estimated delivery date |
| event.data.trackingStatusDesc | Description of the latest tracking status |
| event.data.updatedDate | Date and time of the last update |
| event.id | Unique identifier for the event |
| event.createdAt | Timestamp when the event was created |
Related Articles
How to enable webhook in sandbox?
To enable webhook, Go to More >> Developer Panel (https://sandbox.onlinecheckwriter.com/manage/developer/index) Under the Webhook settings window, provide the necessary details. Webhook Signature Validation To secure our webhook events, we are ...How to Mail Documents (PDF) via OCW API
Guide: How to Mail Documents (PDF) Welcome! This comprehensive guide will walk you through mailing PDF documents physically to any destination address. With a single API request, you can upload your document, specify sender and recipient details, and ...Mailing Checks with PDF Attachments via OCW API
Guide: How to Mail Checks with PDF Attachments Welcome! This simplified guide will walk you through the complete workflow: from creating a check record with advanced details to physically mailing it with a PDF attachment (like an invoice or receipt). ...How to enable webhook in production?
To enable webhook, Go to More >> Developer Panel (https://live.onlinecheckwriter.com/manage/developer/index) Under the Webhook settings window, provide the necessary details. 1. Webhook URL: The URL to receive the webhook. 2. Secret key: Set any key ...How to Mail HTML Document Templates via OCW API
Guide: How to Mail Documents via HTML Templates Welcome! This comprehensive guide will walk you through the complete workflow of mailing HTML documents physically to any destination address. You'll learn how to configure your Developer Panel, upload ...