Publish Alert Event

Loading...

API endpoint path: /db-events/v1/realtime-events

Trigger an alert notification when an event occurs. This API processes the event data and sends notifications based on the configured alert type, template, and customer preferences.

Event Domain Types:

• AccountEvent: Account-related alerts (balance changes, low balance, etc.)
• TransactionEvent: Transaction-related alerts (large transactions, payment exceeding limit, etc.)
• NotificationEvent: Messages from external parties (such as Visa) that pass through to the customer without additional processing
• UserEvent: User-related events (login, password change, etc.)

Processing Flow:

1. Event is received and validated
2. Alert type and user preferences are matched
3. Template is applied with event data
4. Notifications are sent via configured channels (EMAIL, SMS, PUSH)

Request

Responses

202

Event accepted

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal error. Error codes: PRMSYS_10002 (Malformed input data), PRMSYS_10003 (Missing eventDetails or notification), PRMSYS_10007 (Missing mandatory fields), PRMSYS_10008 (Invalid institutionId), PRMSYS_10013 (Missing Authorization Token)