Skip to main content
WEBHOOK
onInvoiceEvent
{
  "id": "whe_example",
  "createdAt": "2024-11-16T01:12:44.641898",
  "updatedAt": "2024-11-16T01:12:44.641898",
  "scheduledAt": null,
  "processedAt": null,
  "status": "PENDING",
  "operation": "UPDATE",
  "payload": {
    "new": {
      "id": "inv_example",
      "number": "1004",
      "status": "PAID",
      "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-16T01:12:42.4475+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": "PAID",
      "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-16T00:59:33.492433+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": false,
      "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": []
}

Body

application/json

Details that are sent over to the webhook

A payload structure for webhook events triggered by operations in Upwell, detailing the affected resource, tenant, operation type, and resource state.

ā€‹
id
string

The unique identifier for the event.

ā€‹
createdAt
string<date-time>

The timestamp when the event was created.

ā€‹
updatedAt
string<date-time>

The timestamp when the event was last updated.

ā€‹
scheduledAt
string<date-time> | null

The timestamp when the event is scheduled to be processed.

ā€‹
processedAt
string<date-time> | null

The timestamp when the event was processed.

ā€‹
status
string

The status of the event (e.g., PENDING).

ā€‹
operation
enum<string>

The operation type that triggered the event.

Available options:
INSERT,
UPDATE,
DELETE
ā€‹
payload
object

Data regarding the state of the resource involved in the event.

ā€‹
table
string

The type of resource in the Upwell application where the event occurred.

ā€‹
resourceId
string

The unique identifier for the resource affected by the event.

ā€‹
webhookSubscriptionId
string

The unique identifier for the webhook subscription.

ā€‹
retryOfId
string | null

The ID of the event being retried, if applicable.

ā€‹
retries
object[]

An array of retry attempts for the event.

Response

200

Return a 200 status to indicate that the data was received successfully