Agent Activity

New Email

v1 equivalent: none. v2 only.

Sent when an inbound email relating to one of your loads is received by an Augment agent. participants and subject identify the email, while summary and classification describe what it was about.

post/NEW_EMAIL

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

Event name for a received email.

Example request

{
  "data": {
    "attachmentCount": 1,
    "participants": {
      "from": {
        "name": "Jane Dispatcher",
        "address": "dispatch@carrier.com"
      },
      "to": [
        {
          "name": "Jane Dispatcher",
          "address": "dispatch@carrier.com"
        }
      ],
      "cc": [
        {
          "name": "Jane Dispatcher",
          "address": "dispatch@carrier.com"
        }
      ]
    },
    "subject": "RE: LOAD-456 delivery update",
    "summary": "Carrier reports delivery completed at 14:05.",
    "classification": "LOAD_TRACKING"
  }
}

Response

Event acknowledged

Changes

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