Optional

Sent Text Message

​

v1 equivalent: none. v2 only.

Sent when an Augment agent sends a text message on one of your loads.

This event records that the message was sent, not that it reached the handset. The envelope's occurredAt is when Augment sent it.

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

      Sent text message data payload.

    • eventType
      enum
      const:  
      SENT_EXTERNAL_TEXT_MESSAGE
      required

      Event name for a text message sent by an Augment agent.

      values
      • SENT_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/SENT_EXTERNAL_TEXT_MESSAGE
curl /SENT_EXTERNAL_TEXT_MESSAGE \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "evt_01HZXK9P7QM3N8YV4TBWJC2RDN",
  "workflow": "TRACK_AND_TRACE",
  "occurredAt": "2026-05-13T12:34:56Z",
  "loadNumber": "LOAD-456",
  "customerLoadInternalId": "INT-789",
  "eventType": "SENT_EXTERNAL_TEXT_MESSAGE",
  "data": {
    "direction": "OUTBOUND",
    "message": "Hi Jane, checking in on LOAD-456 — any update on ETA?",
    "contactType": "CarrierContact",
    "contact": {
      "name": "Jane Dispatcher",
      "externalId": "CONTACT-123",
      "email": "dispatch@carrier.com",
      "phone": "+15551234567",
      "phoneExtension": null
    },
    "attachmentCount": 0
  }
}'
No Body

Event acknowledged