Quick Start: Connect to Message Queue!

Before we get into the everything that is Newline's Message Queue, for those who are familiar with pub/sub messaging structures, we've listed out a quick start guide for getting up and running.

Step 1: Establish Authentication to Message Queue

The first step will be establishing your authenticated connection to our MQ. Please refer to the credentials provided by your Newline Specialist. You can refer to our Authentication guide for details on how to test your connection.

Step 2: Confirming Topics for Business Need

As part of your onboarding, your Newline Specialist will provide preset Topics based on foundational implementation conversations. Prior to money movement, we'll want to confirm the existing Topics are correct and include any events of interest. Our Topics guide includes all supported events, so be sure to check there prior to confirming!

NoteIf you have need of a customized event or have feedback on the current supported events, reach out to your Newline Specialist and confirm any interim options.

Step 3: Creating Durable Subscriptions

Once you've confirmed your needed Topics, the last step is creating a Subscription! We recommend making durable Subscriptions, as they retain a copy of any message sent to the Topic, regardless if there is a server failure or restart.

If you're not sure where to start, check out the Subscriptions guide for an example and resources.

Introduction: What is the Message Queue?

The Message Queue (MQ) is designed to provide API users with the most up-to-date information on Program and Customer level events. These events can include changes to financial products and accounts, alerts and notifications, and more.

In other words, MQ allows Newline to publish information on a variety of topics that users can subscribe to in order to pull said information. Webhooks are another common strategy when providing users internal system or API resource-related updates; however, the benefit MQ affords is that users don't need to adhere to rigid, API definitions for message reception. Rather, they can consume from our queue using flexible setups that fit their specific need or use case.

Newline has implemented MQ to enable a variety of user experiences for our users. This document describes the features of the MQ, how to build against the MQ, and the available event notifications and messages.

Keywords: Message Queue; Apache Active MQ; Topics; Subscriptions; Events; Triggers; Durable

Supported Features

Newline sends real-time event notifications for our Clients to consume when significant events occur. We use Apache ActiveMQ as our message broker; in addition, we use AWS MQ, which is a managed message broker service on top of Apache ActiveMQ. Clients may use a variety of protocols to connect to the message broker, including AMQP, STOMP, MQTT, and WSS.

Topics and Subscriptions

  • Newline publishes messages to durable topics. The topic categorizes a specific event in each Newline environment. Clients will set up subscriptions to each topic to consume event messages.

  • The MQ uses durable topics so that subscribers do not need to maintain an always-on connection to consume messages. A subscriber may disconnect and reconnect freely, always starting from the position in the queue where they left off.

  • Clients may set up multiple subscriptions to the same topic, and each of these subscriptions will receive their own copy of each message. No subscription will receive messages that were sent before the subscriber was established.

NoteAs noted above, it's highly recommended that Clients create durable subscriptions as well. Durable subscriptions allow you to continually consume published messages without having to create a new subscription each time you connect by retaining fault-tolerant message copies..