Skip to main content

Alert

Base path: /api/data/alert

All alert CRUD endpoints are registered but not yet implemented — handlers are empty stubs.

POST /api/data/alert

Create a new alert record.

Auth: Session cookie required Tenant: Scoped via x-tenant-id header

Not yet implemented — returns no response.

Alert Schema Reference

FieldTypeRequiredDescription
tenantIdstringYesTenant identifier
typeenumYesLOW_INVENTORY, NEW_ORDER, PAYMENT_FAILED, FULFILLMENT_FAILED
severityenumYesINFO, WARN, ERROR
messagestringYesAlert message
entityTypestringNoRelated entity type
entityIdstringNoRelated entity ID
isReadbooleanNoRead status (default false)
createdAtdateYesCreation timestamp
updatedAtdateYesLast update timestamp

GET /api/data/alert/:id

Retrieve an alert by ID.

Auth: Session cookie required Tenant: Scoped via x-tenant-id header

Not yet implemented — returns no response.


PATCH /api/data/alert/:id

Update an alert by ID.

Auth: Session cookie required Tenant: Scoped via x-tenant-id header

Not yet implemented — returns no response.


DELETE /api/data/alert/:id

Delete an alert by ID.

Auth: Session cookie required Tenant: Scoped via x-tenant-id header

Not yet implemented — returns no response.