CommentEvent

  • Common envelope fields shared by v2 webhook events. Each concrete event schema adds its own eventType and typed data payload.

    • 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

      values
      • TRACK_AND_TRACE
      • CARRIER_SUPPORT
      • null