Optional

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.

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

      Workflow status data payload.

    • eventType
      enum
      const:  
      WORKFLOW_STATUS_UPDATE
      required

      Event name for a workflow status change.

      values
      • WORKFLOW_STATUS_UPDATE
    • 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/WORKFLOW_STATUS_UPDATE
curl /WORKFLOW_STATUS_UPDATE \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "evt_01HZXK9P7QM3N8YV4TBWJC2RDP",
  "workflow": "TRACK_AND_TRACE",
  "occurredAt": "2026-05-13T12:34:56Z",
  "loadNumber": "LOAD-456",
  "customerLoadInternalId": "INT-789",
  "eventType": "WORKFLOW_STATUS_UPDATE",
  "data": {
    "status": "ESCALATED",
    "agent": "TRACK_AND_TRACE_AGENT",
    "context": "Carrier unreachable after three attempts.",
    "statusReasonCode": "MISSING_CONTACT_INFO"
  }
}'
No Body