Handle carrier invoice status portal exception events

{
  "id": "whe_example",
  "createdAt": "2024-11-17T22:53:28.323541",
  "updatedAt": "2024-11-17T22:53:28.323541",
  "scheduledAt": null,
  "processedAt": null,
  "status": "PENDING",
  "operation": "UPDATE.status.EXCEPTION",
  "payload": {
    "new": {
      "id": "cari_example",
      "status": "EXCEPTION",
      "balance": 213335,
      "bill_id": null,
      "currency": "USD",
      "due_date": "2024-11-22",
      "metadata": null,
      "tenant_id": "ten_example",
      "carrier_id": "car_example",
      "created_at": "2024-11-16T00:59:33.492433+00:00",
      "deleted_at": null,
      "issue_date": "2023-08-28",
      "updated_at": "2024-11-17T22:53:22.368671+00:00",
      "load_number": "LOAD-2000",
      "received_at": "2024-11-16T00:59:33.492433+00:00",
      "shipment_id": null,
      "total_amount": 213335,
      "invoice_number": "2000",
      "total_tax_amount": 0,
      "reference_numbers": null,
      "source_system_meta": {
        "type": "ACCOUNTS_PAYABLE",
        "mergeId": "mergeId_placeholder",
        "remoteId": "remoteId_placeholder",
        "field_mappings": {
          "organization_defined_targets": null,
          "linked_account_defined_targets": null
        },
        "remote_updated_at": "2023-10-27T21:01:26.843954",
        "remote_was_deleted": false,
        "tracking_categories": []
      },
      "customer_invoice_id": null,
      "created_from_email_message_id": null,
      "documents_type_or_customer_visibility_updated_at": null
    },
    "old": {
      "id": "cari_example",
      "status": "UNDER_REVIEW",
      "balance": 213335,
      "bill_id": null,
      "currency": "USD",
      "due_date": "2024-11-22",
      "metadata": null,
      "tenant_id": "ten_example",
      "carrier_id": "car_example",
      "created_at": "2024-11-16T00:59:33.492433+00:00",
      "deleted_at": null,
      "issue_date": "2023-08-28",
      "updated_at": "2024-11-17T22:47:01.635235+00:00",
      "load_number": "LOAD-2000",
      "received_at": "2024-11-16T00:59:33.492433+00:00",
      "shipment_id": null,
      "total_amount": 213335,
      "invoice_number": "2000",
      "total_tax_amount": "0",
      "reference_numbers": null,
      "source_system_meta": {
        "type": "ACCOUNTS_PAYABLE",
        "mergeId": "mergeId_placeholder",
        "remoteId": "remoteId_placeholder",
        "field_mappings": {
          "organization_defined_targets": null,
          "linked_account_defined_targets": null
        },
        "remote_updated_at": "2023-10-27T21:01:26.843954",
        "remote_was_deleted": false,
        "tracking_categories": []
      },
      "customer_invoice_id": null,
      "created_from_email_message_id": null,
      "documents_type_or_customer_visibility_updated_at": null
    }
  },
  "table": "carrier_invoices",
  "webhookSubscriptionId": "whs_example",
  "resourceId": "cari_example",
  "retryOfId": null,
  "retries": []
}

WEBHOOK

onCarrierInvoiceStatusPortalExceptionEvent

{
  "id": "whe_example",
  "createdAt": "2024-11-17T22:53:28.323541",
  "updatedAt": "2024-11-17T22:53:28.323541",
  "scheduledAt": null,
  "processedAt": null,
  "status": "PENDING",
  "operation": "UPDATE.status.EXCEPTION",
  "payload": {
    "new": {
      "id": "cari_example",
      "status": "EXCEPTION",
      "balance": 213335,
      "bill_id": null,
      "currency": "USD",
      "due_date": "2024-11-22",
      "metadata": null,
      "tenant_id": "ten_example",
      "carrier_id": "car_example",
      "created_at": "2024-11-16T00:59:33.492433+00:00",
      "deleted_at": null,
      "issue_date": "2023-08-28",
      "updated_at": "2024-11-17T22:53:22.368671+00:00",
      "load_number": "LOAD-2000",
      "received_at": "2024-11-16T00:59:33.492433+00:00",
      "shipment_id": null,
      "total_amount": 213335,
      "invoice_number": "2000",
      "total_tax_amount": 0,
      "reference_numbers": null,
      "source_system_meta": {
        "type": "ACCOUNTS_PAYABLE",
        "mergeId": "mergeId_placeholder",
        "remoteId": "remoteId_placeholder",
        "field_mappings": {
          "organization_defined_targets": null,
          "linked_account_defined_targets": null
        },
        "remote_updated_at": "2023-10-27T21:01:26.843954",
        "remote_was_deleted": false,
        "tracking_categories": []
      },
      "customer_invoice_id": null,
      "created_from_email_message_id": null,
      "documents_type_or_customer_visibility_updated_at": null
    },
    "old": {
      "id": "cari_example",
      "status": "UNDER_REVIEW",
      "balance": 213335,
      "bill_id": null,
      "currency": "USD",
      "due_date": "2024-11-22",
      "metadata": null,
      "tenant_id": "ten_example",
      "carrier_id": "car_example",
      "created_at": "2024-11-16T00:59:33.492433+00:00",
      "deleted_at": null,
      "issue_date": "2023-08-28",
      "updated_at": "2024-11-17T22:47:01.635235+00:00",
      "load_number": "LOAD-2000",
      "received_at": "2024-11-16T00:59:33.492433+00:00",
      "shipment_id": null,
      "total_amount": 213335,
      "invoice_number": "2000",
      "total_tax_amount": "0",
      "reference_numbers": null,
      "source_system_meta": {
        "type": "ACCOUNTS_PAYABLE",
        "mergeId": "mergeId_placeholder",
        "remoteId": "remoteId_placeholder",
        "field_mappings": {
          "organization_defined_targets": null,
          "linked_account_defined_targets": null
        },
        "remote_updated_at": "2023-10-27T21:01:26.843954",
        "remote_was_deleted": false,
        "tracking_categories": []
      },
      "customer_invoice_id": null,
      "created_from_email_message_id": null,
      "documents_type_or_customer_visibility_updated_at": null
    }
  },
  "table": "carrier_invoices",
  "webhookSubscriptionId": "whs_example",
  "resourceId": "cari_example",
  "retryOfId": null,
  "retries": []
}

Authorizations

Authorization

string

header

required

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

application/json

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.

string

The unique identifier for the event.

trigger

string

The trigger string for this event (e.g. update.carrier_invoice.status.APPROVED). Branch on this — see the webhook event catalog.

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

string

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.

payload

object

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

Show child attributes

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

⌘I