Skip to main content
POST
onCarrierInvoiceUpdateShipmentUpdatedEvent

Body

application/json

Details of the carrier invoice shipment update

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.

Response

200

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