Handle carrier invoice shipment creation events

Body

application/json

Details of the carrier invoice shipment creation

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

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.

Show child attributes

payload.new

object

The new values of the resource after the operation (for INSERT and UPDATE events). Contains all fields of the resource.

payload.old

object

The previous values of the resource before the operation (for UPDATE and DELETE events). Contains all fields of the resource.

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.

Response

200

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

Carrier Payment Line Items

Vendors

Invoice Line Items

Carrier Invoices

Carrier Invoice Documents

Documents

Addresses

Carriers

Bill Line Items

Stops

Customer Payments

Bills

Customer Payment Line Items

Rules

Invoice Shipments

Companies

Invoices

Invoice Documents

Customers

Carrier Invoice Approval Requests

Shipments

Shipment Documents

Bill Payments

Webhooks

Handle carrier invoice shipment creation events

Body

Response