EventEnvelope

Common envelope shared by Track & Trace webhook events. Use eventType to determine how to interpret the data field.

  • brokerageLoadInternalId
    Type: string | null
    required

    Your internal load ID, if provided during load creation

  • data
    Type: object
    required

    Event-specific payload. Shape depends on eventType.

  • eventType
    Type: stringenum
    required

    Determines the shape of data

    values
    • TRANSIT_UPDATE
    • STOP_UPDATE
    • CARRIER_INFO_UPDATE
    • COMMENT
    • SCHEDULED_CARRIER_OUTREACH
  • id
    Type: string
    required

    Unique event identifier (ULID)

  • loadNumber
    Type: string | null
    required

    Your load reference number

  • occurredAt
    Type: stringFormat: date-time
    required

    When the underlying activity occurred (ISO 8601)

  • workflow
    Type: string | nullenum
    required

    The Augment workflow that produced this event

    values
    • TRACK_AND_TRACE
    • null