Optional

Comment

v1 equivalent: comment (flat payload).

Sent when Augment sends or receives a carrier communication (email, phone, or text) that does not produce a distinct structured event like TRACKING_UPDATE, STOP_UPDATE or LOAD_CARRIER_UPDATE. Use this event to capture communication activity that does not map to a specific tracking or carrier update.

Body·

required

application/json

Fields present on every v2 webhook event.

- customerLoadInternalId
  Type: string | null
  required
  
  Your internal load ID, if provided during load creation
- data
  Type:
  required
  
  Comment data payload.
  
  Properties: 1
- eventType
  enum
  const:
  SEND_TMS_COMMENT
  required
  
  Event name for an unstructured communication comment.
- 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, 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_TRACECARRIER_SUPPORTPOD_COLLECTIONLOAD_BUILDINGCARRIER_SELECTIONSCHEDULINGCUSTOMER_SUPPORTnull

Responses

200

Event acknowledged

post/SEND_TMS_COMMENT

curl /SEND_TMS_COMMENT \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "",
  "workflow": "TRACK_AND_TRACE",
  "occurredAt": "",
  "loadNumber": "",
  "customerLoadInternalId": "",
  "eventType": "SEND_TMS_COMMENT",
  "data": {
    "comment": "Driver Marcus confirmed pickup of load test12345 from Dallas and is en route to Atlanta with ETA of tomorrow 2pm."
  }
}'

No Body

Event acknowledged

Carrier Info Update

Scheduled Carrier Outreach

Comment

Body·CommentEvent

Responses

Body·