Skip to main content

The envelope delivered to your webhook endpoint for every event. The type field identifies the event and selects the shape of data.

eventId
string
required

A unique identifier for this event delivery. Use it to deduplicate incoming webhooks — if the same eventId arrives more than once (for example, after a network retry), treat the second delivery as a no-op.

actorId
string
required

The actor that triggered this event, expressed as a prefixed identifier:

  • usr_<userId> when the action was taken by a Cargado user (broker or carrier acting through the Cargado UI).
  • api_<apiKeyId> when the action was taken via the public API using one of your API keys.
type
enum<string>
required

The kind of event being delivered. Use it to route the payload to the right handler on your side.

Available options:
bid.submitted,
bid.accepted,
bid.rejected,
bid.revoked,
bid.closed,
bid.countered,
bid.counter_accepted,
bid.counter_revoked,
bid.counter_rejected
timestamp
string<date-time>
required

The time the event occurred, as an ISO-8601 timestamp. This is the time of the underlying state change, not the time the webhook was delivered.

data
any
required

The event-specific payload. Its shape depends on type — see the event families (bid) for the concrete data types.