Agent Activity

Workflow Status Update

v1 equivalent: none. v2 only.

Sent when an Augment agent workflow on one of your loads changes state — for example when it completes, is canceled, escalates to a human, or errors. Use it to mirror agent progress in your TMS.

statusReasonCode is free-form and workflow-specific; treat it as an open set and do not branch on values you have not agreed with Augment.

post/WORKFLOW_STATUS_UPDATE

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

Event name for a workflow status change.

Example request

{
  "data": {
    "agent": "TRACK_AND_TRACE_AGENT",
    "context": "Carrier unreachable after three attempts.",
    "statusReasonCode": "MISSING_CONTACT_INFO"
  }
}

Response

Event acknowledged

Changes

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