Overview

This page provides detailed definitions for each supported webhook topic. Topics are logical groupings of related events that clients can subscribe to for real-time updates.

Understanding these definitions helps ensure subscriptions align with business workflows and integration requirements.

How does a Webhook Topic Work?

Each topic represents a category of events tied to a specific entity.

Examples include:

• Transfer
• Transaction
• Synthetic Account
• Virtual Reference Number
• Customer
• Debit Card

Clients can subscribe using one of the following models.

Topic-Level

Receive all events associated with a topic.

Event-Level

Receive only selected events within a topic.

Combination

Mix topic-level and event-level subscriptions to support more granular event delivery requirements.

Routing Behavior

Webhook delivery routing is topic-based.

Events are delivered to the endpoint associated with the subscribed topic path regardless of subscription type.

The event_type field identifies the event contained within the payload but is not used to determine the delivery endpoint.

Topic Naming Convention

Webhook endpoints follow the format:

{base_url}/webhook/{topic-path}

Where:

• base_url is provided by the client
• /webhook is a required path segment
• topic-path is derived from the subscribed topic

Examples

https://example.com/webhook/transfer

https://example.com/webhook/virtual-reference-number

Topic names are defined by Newline and cannot be customized by clients.

Topic Definitions

Transfer

Events related to money movement between accounts.

Supported events include:

• Transfer Initiated
• Transfer Status Changed
• RTP Settlement

Transaction

Events related to transaction lifecycle activity.

Supported events include:

• Transaction Created
• Transaction Status Updated

Synthetic Account

Events related to synthetic account management and maintenance.

Supported events include all events associated with synthetic account activity.

Virtual Reference Number

Events related to virtual reference number creation, registration, and maintenance.

Supported events include all events associated with virtual reference number activity.

Customer

Events related to customer lifecycle and customer record activity.

Supported events include all events associated with customer activity.

Debit Card

Events related to debit card issuance, status changes, and lifecycle activity.

Supported events include all events associated with debit card activity.

Subscription Guidance

When selecting a webhook topic:

• Subscribe only to topics relevant to your business workflow.
• Use topic-level subscriptions when all events within a topic are required.
• Use event-level subscriptions when only specific events are required.
• Use a combination subscription model to support more granular delivery requirements.

Endpoint Routing Examples

A subscription to the Transfer topic may result in delivery to:

https://example.com/webhook/transfer

A subscription to the Virtual Reference Number topic may result in delivery to:

https://example.com/webhook/virtual-reference-number

Regardless of whether a client subscribes at the topic level or event level, events are delivered to the endpoint associated with the topic path.

The event_type value identifies the event contained in the payload, while the topic path determines the delivery endpoint.