Overview

The Notifications module allows you to subscribe to platform notifications and receive updates directly via email to your registered address(es). This helps you stay informed of important events that may impact your operations without needing to actively monitor the dashboard.

Notifications are available for the following events:

• Maintenance Email: Maintenance Starts, Maintenance Completed
• Name Mismatch Email: Pay Out Name Mismatch

If you prefer to receive events programmatically via webhook, please refer to the Webhook Events documentation here.

Managing Notifications

To view, create, edit, or delete notifications, you must log in to your Xenith account with the Notifications organisation permission enabled. Without this permission, these actions will not be available. Navigate to the Notifications tab on your dashboard to get started.

1. Search: Locate a specific entry by email address.
2. New Recipient: Click to add and configure new entry.
3. Expand Row: Click the arrow icon of each entry view the complete details of each entry.
   1. Subscription and Event: Displays each entry subscription or event — Maintenance Starts, Maintenance Completed, or Pay Out Name Mismatch.
   2. Email Address: Shows email address(es) registered in the entry.
4. Sort: Organize entries in ASC or DESC value by Updated Date (default) or Created Date.

Create a New Notification Entry

Follow these steps to create a new Notification entry:

1. Initiate Notification Creation: Click the "+ New Recipient" button.
2. Enter Recipient Detail:
   • Email Address (required) — Enter the recipient email address, then type a comma and space to add more. You can add up to 1,000 email addresses per entry.
3. Select Notification Detail:
   • Subscription and Event (required) — choose from:
     • Maintenance Email: Maintenance Start or Completed
     • Name Mismatch Email: Pay Out Name Mismatch
4. Save: Click "Save" to complete the subscription.

A successful entry will shows "Recipient successfully created". If the new entry results in a duplicate email address + event combination, you'll see "Recipient has already subscribed to the event" instead.

Edit an Existing Notification Entry

Follow these steps to edit an existing Notifications entry:

1. Initiate Edit: Click the three-dot menu (⋮) next to the entry you want to edit, and select "Edit".
2. Modify Recipient Detail: The Email Address field is prefilled with the current recipient email address(es). Add or remove emails as needed.
3. Modify Notification Detail: The Subscription and Event field is prefilled and editable — open the dropdown to change the event selection.
4. Save: Click "Save" to apply your changes.

A successful update shows "Recipient successfully updated". If the change results in a duplicate email address + event combination, you'll see "Recipient has already subscribed to the event" instead.

Delete an Existing Notifications Entry

Follow these steps to delete an existing Notifications entry:

1. Initiate Deletion: Click the three-dot menu (⋮) next to the entry you want to remove, and select "Delete".
2. Confirm Deletion: A confirmation pop-up will appear. Click "Delete" to proceed.
3. Verify Removal: Check the Notifications list to confirm the recipient has been removed.