Agent Activity

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.

post/RECEIVED_EXTERNAL_TEXT_MESSAGE

Request

Base URL
https://apidocs.goaugment.com (the document declares no server; this is the origin it was published from)
Auth
none declared
TypeScript
https://skmtc.dev/goaugment/apis/webhooks/docs/RECEIVED_EXTERNAL_TEXT_MESSAGE/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

idstring required

Unique event identifier (ULID)

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.

occurredAtstring date-time required

When the underlying activity occurred (ISO 8601)

loadNumberstring nullable required

Your load reference number

customerLoadInternalIdstring nullable required

Your internal load ID, if provided during load creation

eventType'RECEIVED_EXTERNAL_TEXT_MESSAGE' required

Event name for a received text message.

Example request

{
  "data": {
    "message": "Running about an hour behind, hitting traffic on I-80.",
    "summary": "Driver reports a one-hour delay due to traffic.",
    "classification": "LOAD_TRACKING"
  }
}

Response

Event acknowledged

Changes

No recorded changes to this operation across all 1 revision of this API.