{
"id": "whe_example",
"createdAt": "2024-11-17T22:20:27.471642",
"updatedAt": "2024-11-17T22:20:27.471642",
"scheduledAt": null,
"processedAt": null,
"status": "PENDING",
"operation": "UPDATE.status.SENT",
"payload": {
"new": {
"id": "inv_example",
"number": "1004",
"status": "SENT",
"balance": 0,
"sent_at": null,
"currency": "USD",
"due_date": "2024-10-23",
"metadata": null,
"ship_date": null,
"tenant_id": "ten_example",
"created_at": "2024-11-16T00:59:33.492433+00:00",
"issue_date": "2023-09-15",
"updated_at": "2024-11-17T22:20:24.543408+00:00",
"customer_id": "cus_example",
"portal_slug": "transporeon",
"received_at": null,
"statement_id": null,
"total_amount": 236952,
"delivery_date": null,
"source_system": null,
"hold_for_review": true,
"company_division": null,
"delivery_methods": [
"transporeon"
],
"portal_exception": null,
"source_system_id": null,
"total_tax_amount": 17552,
"debits_updated_at": null,
"reference_numbers": null,
"source_system_meta": {
"type": "ACCOUNTS_RECEIVABLE",
"mergeId": "1395f876-4e6e-4fad-88c2-1dd0ce401a1f",
"remoteId": "12",
"field_mappings": {
"organization_defined_targets": null,
"linked_account_defined_targets": null
},
"remote_updated_at": "2023-01-27T20:59:21Z",
"remote_was_deleted": false,
"tracking_categories": []
},
"document_exceptions": null,
"sent_to_portal_slug": null,
"scheduled_payment_date": null,
"invoice_creation_event_id": null,
"received_from_portal_slug": "transporeon",
"line_items_last_updated_at": "2024-11-16T00:59:33.492433+00:00",
"file_associations_updated_at": null,
"created_from_email_message_id": null
},
"old": {
"id": "inv_example",
"number": "1004",
"status": "PORTAL_EXCEPTION",
"balance": 0,
"sent_at": null,
"currency": "USD",
"due_date": "2024-10-23",
"metadata": null,
"ship_date": null,
"tenant_id": "ten_example",
"created_at": "2024-11-16T00:59:33.492433+00:00",
"issue_date": "2023-09-15",
"updated_at": "2024-11-17T22:17:10.963272+00:00",
"customer_id": "cus_example",
"portal_slug": "transporeon",
"received_at": null,
"statement_id": null,
"total_amount": 236952,
"delivery_date": null,
"source_system": null,
"hold_for_review": true,
"company_division": null,
"delivery_methods": [
"transporeon"
],
"portal_exception": null,
"source_system_id": null,
"total_tax_amount": 17552,
"debits_updated_at": null,
"reference_numbers": null,
"source_system_meta": {
"type": "ACCOUNTS_RECEIVABLE",
"mergeId": "1395f876-4e6e-4fad-88c2-1dd0ce401a1f",
"remoteId": "12",
"field_mappings": {
"organization_defined_targets": null,
"linked_account_defined_targets": null
},
"remote_updated_at": "2023-01-27T20:59:21Z",
"remote_was_deleted": false,
"tracking_categories": []
},
"document_exceptions": null,
"sent_to_portal_slug": null,
"scheduled_payment_date": null,
"invoice_creation_event_id": null,
"received_from_portal_slug": "transporeon",
"line_items_last_updated_at": "2024-11-16T00:59:33.492433+00:00",
"file_associations_updated_at": null,
"created_from_email_message_id": null
}
},
"table": "invoices",
"webhookSubscriptionId": "whs_example",
"resourceId": "inv_example",
"retryOfId": null,
"retries": []
}Handle invoice status sent events
Triggered when the status of an invoice record is updated to sent.
{
"id": "whe_example",
"createdAt": "2024-11-17T22:20:27.471642",
"updatedAt": "2024-11-17T22:20:27.471642",
"scheduledAt": null,
"processedAt": null,
"status": "PENDING",
"operation": "UPDATE.status.SENT",
"payload": {
"new": {
"id": "inv_example",
"number": "1004",
"status": "SENT",
"balance": 0,
"sent_at": null,
"currency": "USD",
"due_date": "2024-10-23",
"metadata": null,
"ship_date": null,
"tenant_id": "ten_example",
"created_at": "2024-11-16T00:59:33.492433+00:00",
"issue_date": "2023-09-15",
"updated_at": "2024-11-17T22:20:24.543408+00:00",
"customer_id": "cus_example",
"portal_slug": "transporeon",
"received_at": null,
"statement_id": null,
"total_amount": 236952,
"delivery_date": null,
"source_system": null,
"hold_for_review": true,
"company_division": null,
"delivery_methods": [
"transporeon"
],
"portal_exception": null,
"source_system_id": null,
"total_tax_amount": 17552,
"debits_updated_at": null,
"reference_numbers": null,
"source_system_meta": {
"type": "ACCOUNTS_RECEIVABLE",
"mergeId": "1395f876-4e6e-4fad-88c2-1dd0ce401a1f",
"remoteId": "12",
"field_mappings": {
"organization_defined_targets": null,
"linked_account_defined_targets": null
},
"remote_updated_at": "2023-01-27T20:59:21Z",
"remote_was_deleted": false,
"tracking_categories": []
},
"document_exceptions": null,
"sent_to_portal_slug": null,
"scheduled_payment_date": null,
"invoice_creation_event_id": null,
"received_from_portal_slug": "transporeon",
"line_items_last_updated_at": "2024-11-16T00:59:33.492433+00:00",
"file_associations_updated_at": null,
"created_from_email_message_id": null
},
"old": {
"id": "inv_example",
"number": "1004",
"status": "PORTAL_EXCEPTION",
"balance": 0,
"sent_at": null,
"currency": "USD",
"due_date": "2024-10-23",
"metadata": null,
"ship_date": null,
"tenant_id": "ten_example",
"created_at": "2024-11-16T00:59:33.492433+00:00",
"issue_date": "2023-09-15",
"updated_at": "2024-11-17T22:17:10.963272+00:00",
"customer_id": "cus_example",
"portal_slug": "transporeon",
"received_at": null,
"statement_id": null,
"total_amount": 236952,
"delivery_date": null,
"source_system": null,
"hold_for_review": true,
"company_division": null,
"delivery_methods": [
"transporeon"
],
"portal_exception": null,
"source_system_id": null,
"total_tax_amount": 17552,
"debits_updated_at": null,
"reference_numbers": null,
"source_system_meta": {
"type": "ACCOUNTS_RECEIVABLE",
"mergeId": "1395f876-4e6e-4fad-88c2-1dd0ce401a1f",
"remoteId": "12",
"field_mappings": {
"organization_defined_targets": null,
"linked_account_defined_targets": null
},
"remote_updated_at": "2023-01-27T20:59:21Z",
"remote_was_deleted": false,
"tracking_categories": []
},
"document_exceptions": null,
"sent_to_portal_slug": null,
"scheduled_payment_date": null,
"invoice_creation_event_id": null,
"received_from_portal_slug": "transporeon",
"line_items_last_updated_at": "2024-11-16T00:59:33.492433+00:00",
"file_associations_updated_at": null,
"created_from_email_message_id": null
}
},
"table": "invoices",
"webhookSubscriptionId": "whs_example",
"resourceId": "inv_example",
"retryOfId": null,
"retries": []
}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 that are sent over to the webhook
A payload structure for webhook events triggered by specific field updates in Upwell resources, detailing the affected resource, tenant, operation type, and resource state.
The unique identifier for the event.
The trigger string for this event (e.g. update.carrier_invoice.status.APPROVED). Branch on this ā see the webhook event catalog.
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.
The status of the event (e.g., PENDING).
The operation type that triggered the event. Format for specific field updates is UPDATE.<field>.<value>, where <field> is the updated field, and <value> is the new value, e.g., UPDATE.status.SENT or UPDATE.carrier_invoice.APPROVED.
Data regarding the state of the resource involved in the event.
Show child attributes
Show child attributes
The type of resource in the Upwell application where the event occurred.
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
Response
Return a 200 status to indicate that the data was received successfully