Notification Service

LUSID has a Notification Service that enables you to subscribe to the system events that LUSID and its ecosystem of applications emit, and receive notifications via multiple delivery channels when those events occur. See the list of system events.

For example, you could subscribe to a system event such as:

• A portfolio is created, updated or deleted.

• A scheduled job completes, fails or does not start.

• An order is executed, and many others.

Note: You can trigger the Manual event yourself to notify people or perform actions when non-LUSID activity occurs. See how to do this.

You can subscribe to a system event:

• Unconditionally. That is, you are always notified when the system event occurs.

• Conditionally. So for example you could write a filter to subscribe to the ‘portfolio created’ system event only when portfolios are created in a particular scope, or with a particular name.

When a system event occurs, you can notify:

• People via email.

• People via SMS.

• An AWS queue via SQS.

• An application or service (including LUSID itself) via a webhook. So for example you could subscribe to the ‘portfolio created’ system event and call the LUSID UpsertTransactions API to automatically seed new portfolios with cash.

Providing you have appropriate permissions, you can interact with the Notification Service using the LUSID web app via the Notifications Management > Subscriptions menu:

Alternatively, you can interact with the Notification Service programmatically:

• Using the Notification REST API

• Using the Notification SDK in various languages

• If you have a Luminesce license, using dedicated read and write providers.

Explanation: See the big picture

• Understanding the relationship between system events, subscriptions and notifications

Tutorials: Get started by doing something tangible

• Using a webhook to automatically seed new portfolios with cash

• Using the Manual event to notify people when non-LUSID activity occurs

• Setting up access control for different Notification Service users

Reference: Understand concepts and implications

• What system events can I subscribe to?

• Using LUSID filtering syntax to subscribe to system events conditionally

• Using mustache templates to enrich notification messages

• Performance, terms of service and delivery failures

• Migrating to version 2 of the Notification Service

How-to guides: Get something done

• How do I subscribe to a system event?

• How do I notify people via email when a system event occurs?

• How do I notify people via SMS when a system event occurs?

• How do I create an AWS SQS notification when a system event occurs?

• How do I create a webhook to call a LUSID API when a system event occurs?

• How do I create a webhook to call a third party (non-LUSID) API when a system event occurs?

• How do I remove a notification from a subscription, or unsubscribe completely?