CommentEvent

  • Fields present on every v2 webhook event.

    • customerLoadInternalId
      Type: string | null
      required

      Your internal load ID, if provided during load creation

    • data
      Type: object · CommunicationData
      required

      Comment data payload.

    • eventType
      enum
      const:  
      SEND_TMS_COMMENT
      required

      Event name for an unstructured communication comment.

      values
      • SEND_TMS_COMMENT
    • id
      Type: string
      required

      Unique event identifier (ULID)

    • loadNumber
      Type: string | null
      required

      Your load reference number

    • occurredAt
      Type: string Format: date-time
      required

      When the underlying activity occurred (ISO 8601)

    • workflow
      Type: string | null enum
      required

      The Augment workflow that produced this event, or null when no single workflow can be attributed. New values may be added over time, so treat this as an open set rather than a fixed list.

      values
      • TRACK_AND_TRACE
      • CARRIER_SUPPORT
      • POD_COLLECTION
      • LOAD_BUILDING
      • CARRIER_SELECTION
      • SCHEDULING
      • CUSTOMER_SUPPORT
      • null