Agent Activity

Human Assistance Requested

v1 equivalent: none. v2 only.

Sent when an Augment agent hands a load off to a human. contact is the person at your brokerage the agent routed the request to, so you can surface the handoff to the right queue or rep.

reasonCode says why the agent could not continue on its own.

post/HUMAN_ASSISTANCE_REQUESTED

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/HUMAN_ASSISTANCE_REQUESTED/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'HUMAN_ASSISTANCE_REQUESTED' required

Event name for a human-assistance request.

Example request

{
  "data": {
    "contact": {
      "name": "Jane Dispatcher",
      "externalId": "CONTACT-123",
      "email": "dispatch@carrier.com",
      "phone": "+15551234567",
      "phoneExtension": "204",
      "role": "DISPATCHER"
    }
  }
}

Response

Event acknowledged

Changes

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