{
"id": "whe_example",
"createdAt": "2024-12-10T14:16:44",
"updatedAt": "2024-12-10T14:16:44",
"scheduledAt": null,
"processedAt": null,
"status": "PENDING",
"operation": "UPDATE",
"payload": {
"new": {
"id": "cari_example",
"tenant_id": "ten_example",
"invoice_number": "INV123",
"shipment": {
"id": "ship_example",
"shipment_number": "SHIP123"
},
"status": "RECEIVED",
"shipment_id": "ship_example"
},
"old": {
"id": "cari_example",
"tenant_id": "ten_example",
"invoice_number": "INV123",
"shipment": {
"id": "ship_example",
"shipment_number": "SHIP123"
},
"status": "RECEIVED",
"shipment_id": null
}
},
"table": "carrier_invoices",
"webhookSubscriptionId": "whs_example",
"resourceId": "cari_example",
"retryOfId": null,
"retries": [],
"trigger": "update.carrier_invoice.shipment_updated"
}Handle a changed carrier invoice shipment link
A carrier invoice shipment_id changed. Compare shipment_id on the rows. Both shipment objects contain the same lookup. If this update also enters APPROVED, the dispatcher sends payload.carrierInvoice.
{
"id": "whe_example",
"createdAt": "2024-12-10T14:16:44",
"updatedAt": "2024-12-10T14:16:44",
"scheduledAt": null,
"processedAt": null,
"status": "PENDING",
"operation": "UPDATE",
"payload": {
"new": {
"id": "cari_example",
"tenant_id": "ten_example",
"invoice_number": "INV123",
"shipment": {
"id": "ship_example",
"shipment_number": "SHIP123"
},
"status": "RECEIVED",
"shipment_id": "ship_example"
},
"old": {
"id": "cari_example",
"tenant_id": "ten_example",
"invoice_number": "INV123",
"shipment": {
"id": "ship_example",
"shipment_number": "SHIP123"
},
"status": "RECEIVED",
"shipment_id": null
}
},
"table": "carrier_invoices",
"webhookSubscriptionId": "whs_example",
"resourceId": "cari_example",
"retryOfId": null,
"retries": [],
"trigger": "update.carrier_invoice.shipment_updated"
}Authorizations
Your API key, sent in the Authorization header: Authorization: YOUR_API_KEY. A Bearer prefix is also accepted (Authorization: Bearer YOUR_API_KEY). Keys are created in the Upwell dashboard (Account ā API keys) and are scoped to one organization.
Body
Details of the carrier invoice shipment update
The unique identifier for the event.
Trigger. See the schema for its JSON type and allowed values.
update.carrier_invoice.shipment_updated Timestamp when this record was created in Upwell. It is not the business document date and may be much later when historical data is imported. See createdAt definition.
Timestamp of the record's latest recorded update in Upwell. It is not a shipment event, payment date, or document revision date. See updatedAt definition.
Timestamp when the asynchronous job is scheduled to run. It is not a promise of completion at that time. See scheduledAt definition.
Timestamp recorded for processing the event or job. It is separate from the event's underlying business date. See processedAt definition.
Delivery status of the event.
Operation. See the schema for its JSON type and allowed values.
UPDATE Source table for this delivery, such as carrier_invoices.
The unique identifier for the resource affected by the event.
The unique identifier for the webhook subscription.
The ID of the event being retried, if applicable.
An array of retry attempts for the event.
Show child attributes
Show child attributes
Payload. See the schema for its JSON type and allowed values.
- Option 1
- Option 2
Show child attributes
Show child attributes
Response
Return a 200 status to indicate that the data was received successfully