Optional

Received Text Message

v1 equivalent: none. v2 only.

Sent when an inbound text message relating to one of your loads is received by an Augment agent. message carries the text, while summary and classification describe what it was about.

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: object ·
      required

      Received text message data payload.

    • eventType
      enum
      const:  
      RECEIVED_EXTERNAL_TEXT_MESSAGE
      required

      Event name for a received text message.

      values
      • RECEIVED_EXTERNAL_TEXT_MESSAGE
    • 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
Responses
  • 200

    Event acknowledged

Request Example for post/RECEIVED_EXTERNAL_TEXT_MESSAGE
curl /RECEIVED_EXTERNAL_TEXT_MESSAGE \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "evt_01HZXK9P7QM3N8YV4TBWJC2RDM",
  "workflow": "TRACK_AND_TRACE",
  "occurredAt": "2026-05-13T12:34:56Z",
  "loadNumber": "LOAD-456",
  "customerLoadInternalId": "INT-789",
  "eventType": "RECEIVED_EXTERNAL_TEXT_MESSAGE",
  "data": {
    "direction": "INBOUND",
    "message": "Running about an hour behind, hitting traffic on I-80.",
    "summary": "Driver reports a one-hour delay due to traffic.",
    "classification": "LOAD_TRACKING"
  }
}'
No Body