API ReferenceProperties

Create Cora Alert

<Badge>Available by Request</Badge> Record an operational or safety alert raised by the agent. Persisted only — no paging or delivery yet. A repeated `externalRef` returns `200` with the existing alert instead of creating a new one. `alertType` must match `alertClass` (400). Acknowledge is staff-only. <Note> This endpoint is part of the document-review agent surface. To explore availability for your integration, please contact our team. </Note>

Path parameters

propertyIdstringRequired
The id of the property

Request

This endpoint expects an object.
externalRefstringRequired

Idempotency key — a repeat returns 200 with the existing row.

severityenumRequired
alertClassenumRequired
alertTypeenumRequired

Must match alertClass (400). SAFETY → GUARDRAIL_BLOCK, INAPPROPRIATE_DISCLOSURE_ATTEMPT, UNAUTHORIZED_ACTION, FAILED_AUDIT_RECORD, INSUFFICIENT_EVIDENCE_ACTION. OPERATIONAL → API_FAILURE, DEAD_LETTER_EVENT, STUCK_OR_FAILED_WORKFLOW, PROCESSING_FAILURE.

titlestringRequired
occurredAtdatetimeRequired
detailstringOptional
payloadmap from strings to anyOptional
applicationIdstringOptionalformat: "uuid"
householdIdstringOptionalformat: "uuid"

Response

An alert with this externalRef already exists
alertClassenum
alertTypeenum

Must match alertClass (400). SAFETY → GUARDRAIL_BLOCK, INAPPROPRIATE_DISCLOSURE_ATTEMPT, UNAUTHORIZED_ACTION, FAILED_AUDIT_RECORD, INSUFFICIENT_EVIDENCE_ACTION. OPERATIONAL → API_FAILURE, DEAD_LETTER_EVENT, STUCK_OR_FAILED_WORKFLOW, PROCESSING_FAILURE.

externalRefstring

Idempotency key — a repeat returns 200 with the existing row.

occurredAtdatetime
severityenum
titlestring
alertIdstringOptionalformat: "uuid"
applicationIdstringOptionalformat: "uuid"
detailstringOptional
householdIdstringOptionalformat: "uuid"
payloadmap from strings to anyOptional
statusstringOptional

OPEN on creation. Acknowledge is staff-only.

Errors

400
Create Cora Alert Request Bad Request Error
404
Create Cora Alert Request Not Found Error