Notifications
Notifications Overview
Newline offers two powerful mechanisms for delivering real-time event notifications to clients: Webhooks and Message Queue (MQ). These channels allow your systems to stay up-to-date with key events such as transfers, transactions, account updates, and more.
This page provides a high-level comparison of both delivery methods and helps you choose the best fit for your architecture.
Notification Channels
Feature | Webhooks | Message Queue (MQ) |
---|---|---|
Delivery Model | Push | Pull |
Transport Protocol | HTTPS | STOMP, AMQP, MQTT, WSS |
Setup Complexity | Simple, Durable Subscriptions | Advanced, Durable Subscriptions |
Retry Logic | Automatic retries + health checks | Client-managed |
Best For | Real-time responsiveness | Fault-tolerant, queue-based systems |
Choosing the Right Channel
-
Use Webhooks if you want:
- Immediate push notifications to your HTTPS endpoint
- Simpler setup and integration
- Automatic retry logic for failed deliveries
-
Use Message Queue if you need:
- Subscriptions with fault tolerance
- Support for multiple protocols
- Greater control over message consumption and retry behavior
Next Steps
To get started, choose one of the following guides:
-
🔗 Webhooks Documentation
-
🔗 Message Queue Documentation
Supported Topics
Newline supports a shared set of event topics across both Webhooks and Message Queue (MQ). Each topic represents a category of related events that clients can subscribe to based on their operational or customer-facing needs.
Below are the currently supported topics and their definitions:
Transfers
Events related to the initiation, status changes, and settlement of money transfers.
- Transfer Initiated: A transfer has been created.
- Transfer Status Changed: The status of a transfer has been updated (e.g., pending → settled).
- RTP Settlement: An instant payment transfer has reached settlement.
Transactions
Events that track the creation and status updates of financial transactions.
- Transaction Created: A transaction record has been generated.
- Transaction Status Updated: The status of a transaction has changed (e.g., denied, pending).
Synthetic Accounts
Events related to virtual accounts used for managing funds.
- Synthetic Account Created: A new synthetic account has been created.
- Synthetic Account Status Changed: The account status has been updated (e.g., active, failed).
- Synthetic Account Name Updated: The name of a synthetic account has been changed.
Virtual Reference Numbers (VRNs)
Events related to the creation and registration of virtual reference numbers used for instant payments.
- VRN Created: A new VRN has been issued.
- Instant Payment Rail Registration Status Changed: The registration status for instant payment rails has changed (e.g., pending → archived).
For full topic details and naming conventions, visit the Topics Guide.
For more details, see:
Updated 1 day ago