Skip to navigation
API ReferenceIngestion

Submit an agent interaction event

Submits a single agent interaction event into the AWR evidence chain. The event is assigned a unique correlation ID, evaluated against the tenant’s active rule packs, and written to the immutable ledger.

Idempotency: Supply Idempotency-Key to prevent duplicate ingestion on retried requests. The same key within 24 hours returns the original receipt.

Authentication

X-AWR-Api-Keystring
API key for HTTPS webhook integrations and platform builders.

Headers

Idempotency-KeystringOptional<=128 characters

Client-generated key to ensure at-most-once event ingestion. Re-submitting with the same key within 24 h returns the original response.

X-AWR-Tenant-IdstringOptional

Tenant identifier for multi-tenant platform deployments. Omit for single-tenant or organization-scoped requests.

Request

This endpoint expects an object.
agent_idstringRequired

AWR-registered agent identifier.

session_idstringRequired
Unique session or call identifier from the originating platform.
event_typestringRequired

Dot-separated event type (e.g. appointment.booked, payment.captured, consent.verified, escalation.triggered, record.updated).

occurred_atdatetimeRequired
ISO 8601 timestamp when the action occurred on the originating system.
payloadmap from strings to anyRequired

Arbitrary event payload. AWR will apply redaction rules (PHI, PCI) based on active rule packs before storing.

system_of_recordobjectOptional
Reference to the downstream system updated by this agent action.
metadatamap from strings to stringsOptional

Optional key-value metadata (not subject to compliance redaction).

Response

Event accepted and queued for policy evaluation.
receipt_idstringOptional
AWR receipt identifier. Use to retrieve the full receipt once processing completes.
correlation_idstringOptional
Unique event correlation ID in the AWR ledger.
statusenumOptional
Allowed values:
policy_evaluation_stateenumOptional
Allowed values:
estimated_completion_msintegerOptional
Estimated milliseconds until policy evaluation completes.

Errors

400
Bad Request Error
401
Unauthorized Error
409
Conflict Error
422
Unprocessable Entity Error