Templates

This article lists the data types and notification templates of the Notification folder in the Templates tab of the Events section. Data type and template names are given as they are displayed in the tree; the name of the data type in the Type filter is given in brackets where it differs.

For each data type, the group in which sending of its notifications is configured in the Notification rules tab is specified.

Please note! Besides event notifications, the tree contains the Message ➝ Auth code template - the email and messages with a verification code, e.g. when logging in to the platform. The Common ➝ template common email layout is described in the Templates article.

Logs of all events occurring in the platform are available in the Event log of the History section, and logs of events for a specific account are available in the Account event log.

General functionality

If you click on any of the events in the list, you can see its default display for different notification channels: Email, Push notification, SMS notification, and also notification format in Messengers.

The Template selector allows you to toggle between the default Use default notifications and the customized notification format Use custom.

If you click on the Use custom option, the notification form will become available for editing:

The Available data button opens a sidepage that displays the codes for all fields available for use in notifications. The Window button allows you to enlarge the edit window.

Depending on the notification channel, the following data can be configured for it:

• Emails:
  • Subject - the subject (title) of the notification;
  • HTML - code and content of the notification in HTML markup;
  • CSS - styles and decoration of the notification in CSS markup.
• Push:
  • Subject - subject (title) of the notification;
  • notification text in the editing window
• SMS and Messengers:
  • notification text in the editing window.

After editing a custom notification format, click Save to apply the changes to it.

Template catalog

Auto conversion

Automatic conversion of funds on an account. Rule group Trading errors.

• Failed - automatic conversion on the account has failed. Contains the account number and the error reason.

Chat

Events of support chats on an account. Rule group Chat.

• Join admin - a broker employee has been added to an account chat. Contains the client ID, account number and chat name.
• Join client - a client has been added to an account chat. Contains the account number and chat name.
• Message - a new message in the chat. Contains the sender's name, account number and message text; the email is marked with the Important label.
• Remove - a participant has been removed from the chat. Contains the chat name.

Client report

Daily trading report on an account. Rule group Daily trading reports.

• Sent - the daily trading report has been sent: a report on trading operations and results on the account.
• Resent - the trading report has been sent again.

Connector error

Rule group System warning.

• Error - a connector error. Contains the error description, connector name and ID.

Connector status

Rule group System warning.

• Status - the connector status has changed. Contains the connector name and the new status.

Consolidated report

Consolidated trading report. Rule group Consolidated report. The emails are marked with the Important label.

• Sent - the daily consolidated trading report has been sent, the report is attached to the email.
• Resent - the consolidated report has been sent again.

Copy trading

Events of a subscription to copy a public account. Rule group Copy trading notifications. For more information about subscriptions, see the Public account subscriptions article.

• Balance warning - the subscription account balance is below the minimum, not all positions can be copied. Contains the amount by which the account needs to be topped up.
• Cancel close - the subscription has been cancelled.
• Cancelled - the subscription is being stopped.
• Margin call - the subscription has been paused due to a Margin Call: there are not enough funds on the account, and the account needs to be topped up.
• No margin - the subscription has been paused: a position on an instrument cannot be copied due to insufficient funds.
• No routing - the subscription instrument is not available for trading.
• Paused - the subscription has been paused.
• Position warning - a discrepancy in subscription position amounts has been detected. Contains the subscription ID and the list of instruments.
• Public balance changed - the public account balance has changed. Contains the change amount and the current balance.
• Rebalanced - the subscription ratio has been recalculated, trades will be created to align positions.
• Resumed - the subscription has been resumed.
• Subscribed - the subscription has been activated.

Eod (EOD)

Closing of the trading day. Rule group EOD.

• Error - EOD execution error. Contains the error message.
• Execution - EOD has been executed successfully, the day is closed.
• Reminder - a reminder to close the day.

Fix session

FIX session status change. Rule group System warning.

• Account status - the client session status has changed. Contains the session type, TargetCompID and the new status.
• Principal status - the dealer session status has changed. Contains the session and the new status.

Instrument replacement

Replacement of one instrument with another. Rule group Orders statuses.

• Notify - a warning about an upcoming instrument replacement from the specified date: positions will be kept, active orders will be cancelled.
• Replaced - the instrument has been replaced: positions have been moved to the new instrument, active orders have been cancelled.

Kyc (KYC)

KYC step status change. Rule group User profile. The push notification and the terminal notification are the same for all templates - the step and its new status; the email contains an explanation and a link to the web terminal (except Rejected).

• Additional info required - the step data needs to be corrected, the step is awaiting an update.
• Level expired - the step has expired, the data needs to be updated.
• Level verified - the step verification has been completed successfully.
• On hold - the step processing has been put on hold, the status will be updated later.
• Rejected - the step data has been rejected.
• Submitted - the step data has been submitted for verification.
• Verifying - verification of the step data has started.

Liquidation

Automatic liquidation when the margin level is reached. Templates without the Dealer prefix are configured in the Margin call warning rule group, Dealer ... templates - in the Dealer margin group. The emails are marked with the Important label, except Dealer success.

• Required - the account margin has reached the liquidation level. Contains the account ID and the liquidation level in %.
• Success - the account margin has been normalized.
• Error - liquidation has failed. Contains the reason, account ID, liquidation level and a request to restore the margin balance urgently.
• Dealer required - liquidation is required on the account.
• Dealer success - the margin on the account has been normalized.
• Dealer error - a liquidation error on the account. Contains the reason and the liquidation level.

Margin warning

Margin level warnings. Warning and Critical warning are configured in the Margin call warning rule group, Dealer warning - in the Dealer margin group.

• Warning - the account margin has reached the warning level. The email contains margin utilization, margin balance and liquidation level.
• Critical warning - the Stop Out level has been reached, some positions may be closed automatically. The email contains the same figures and is marked with the Important label.
• Dealer warning - the margin on the account has reached a critical level. Contains the level, margin utilization and margin balance; the email is marked with the Important label.

Order

Trading order statuses. The emails of all templates are marked with the Important label and contain an order table: instrument, order type, duration, side, quantity and price. Rule groups: Order reject - Rejected, Cancel rejected, Replace rejected; Trading dealer - Dealer requested, Dealer cancel requested, Dealer replace requested; Trading errors - Dealer stopped, Dealer cancel rejected, Dealer replace rejected; Orders statuses - the other templates.

The template node contains the common block of order emails: the order table for account emails and for emails to the broker.

• Activated - the order has been activated.
• Cancel rejected - order cancellation has been rejected. Contains the date and time of the cancellation attempt and the rejection reason.
• Cancel requested - an order cancellation request has been created. Orders with manual processing are marked accordingly.
• Cancelled - the order has been cancelled.
• Executed - the order has been executed.
• Expired - the order has expired.
• Partially filled - the order has been partially filled.
• Placed - the order has been placed.
• Rejected - the order has been rejected. Contains the rejection reason.
• Replace rejected - order modification has been rejected. Contains the rejection reason.
• Replace requested - an order modification request has been created. Orders with manual processing are marked accordingly.
• Replaced - the order has been modified.
• Requested - a request to place an order with manual processing has been created.
• Stopped - the order has been stopped, usually due to a platform issue. Such an order is not sent to the provider, so it is recommended to reject it manually.
• Suspended - the order has been held by the platform, e.g. if the provider does not support the order type.
• Dealer requested - an order placement request is awaiting manual processing.
• Dealer cancel requested - an order cancellation request is awaiting manual processing.
• Dealer replace requested - an order modification request is awaiting manual processing.
• Dealer stopped - an order on the account has been stopped.
• Dealer cancel rejected - cancellation of an order on the account has been rejected. Contains the attempt time and the rejection reason.
• Dealer replace rejected - modification of an order on the account has been rejected. Contains the attempt time and the rejection reason.

Payment

Payment orders for cash in and cash out. The push notification contains the payment order number, status, amount and asset, and the reason if declined. Rule groups: Cash in/out request - Created, Canceled, Failed; Account transactions - Executed, Declined.

The template node contains the common block of payment emails: payment method, amount, commission, status, account, payment type, payment system and transaction ID.

• Created - a payment request has been created.
• Executed - the payment has been executed.
• Declined - the payment has been declined. Contains the reason.
• Canceled - the payment request has been cancelled. Contains the reason.
• Failed - the payment has failed.

Payment method

Rule group Payment method app submitted.

• Application submitted - a payment method has been created, the Travel Rule application needs to be reviewed. Contains the application ID, payment method, its status, payment type and payment system.

Price alert

Rule group Price alert.

• Reached - the instrument price has reached the level set in the alert. Contains the instrument, level and current quote.

Profile report

Trading report on a profile. Rule group Profile report. The emails are marked with the Important label.

• Sent - the daily trading report on the profile has been sent: a report on trading operations and results of the profile.
• Resent - the profile report has been sent again.

Settlement confirmation

Rule group Settlement confirmation.

• Sent - a settlement confirmation for a trade has been sent. Contains the trade ID.

Strategy error

Rule group Strategy.

• Error - execution of a strategy order on the target account has failed. Contains the order ID, its status, target account and error text.

System error

Rule group System warning.

• Critical - a critical system error, the logs need to be checked. Contains the comment, class and error message.

Trade

Trades and transfers on an account. The push notification contains the trade and account numbers, amount, instrument, price, commission and value date. Rule groups: Trading except direct - Trade executed, Trade cancelled, Trade corrected, Transfer executed, Transfer cancelled; Trading direct - Trade direct ... templates; Trade creation - Dealer trade; Account transactions - Swap.

The template node contains the common blocks of trade and transfer emails: instrument, account, side, quantity, price, commission, trade date and value date.

• Trade executed - a trade has been created on the account.
• Trade cancelled - the trade has been cancelled. Contains the removal reason, if specified.
• Trade corrected - the trade has been corrected.
• Trade direct executed - a direct trade has been created.
• Trade direct cancelled - the direct trade has been cancelled.
• Trade direct corrected - the direct trade has been corrected.
• Transfer executed - an instrument transfer has been executed. Contains the value date.
• Transfer cancelled - the instrument transfer has been cancelled.
• Dealer trade - a trade has been created on the account. It is configured separately from Trade executed, in the Trade creation group.
• Swap - a swap on an instrument. Contains the position and amount.

Trade idea

Following a trade idea. Rule group Trade ideas notifications.

• Subscribed - following the idea has started. Contains the instrument, idea ID and amount.
• Unsubscribed - following the idea has stopped.
• Activated - the entry price has been reached, the idea has been activated.
• Expired - the idea has expired.
• Cancelled - the idea has been cancelled.
• Rejected - the idea has been rejected.
• Profit - the idea has been closed with a profit. Contains the current P/L.
• Loss - the idea has been closed with a loss. Contains the current P/L.
• Problem - a problem with the idea has occurred. Contains the instrument and idea ID.

Transaction

Cash operations on an account. Rule groups: Cash in operation - Cash in; Cash out operation - Cash out; Dealer transaction - Dealer transfer; the others - Account transactions.

• Cash in - the account has been topped up. Contains the amount, account ID, transaction ID and time, and comment.
• Cash out - funds have been withdrawn from the account. Contains the same data.
• Transfer - a transfer between accounts has been executed. Contains the debit and credit accounts, amount, date and time.
• Coupon - a coupon payment on an instrument. Contains the period, face value, rate, payment frequency and amount.
• Dividend payment - a dividend payment on a position. Contains the payment size and amount.
• Dividend tax - dividend tax on an instrument has been debited.
• Pnl - P/L accrual or debit on a trade. Contains the side, amount, instrument and sum.
• Swap - a swap on a position has been accrued or debited.
• Trade commission - a commission on a trade has been debited.
• Dealer transfer - a user has made a transfer between accounts. Contains the user ID and name, accounts, amount, date and time.

User

User account. Rule groups: User registered - Registered; the others - User profile.

• Activated - the user account has been created. The email contains the name, login, password and a button to go to the platform login.
• Registered - a new user has been registered. Contains the client ID and name.
• Contact updated - contact information has been updated: name, phone, email.
• Password updated - an administrator has assigned a new password to the user. The email contains the new password.
• Password reset - the password has been reset. The email contains the new password.

Wallet address

Crypto wallets and payment methods with Travel Rule verification. Rule group Wallet address.

The template node contains the common block of emails: payment method, its status, payment status, account, payment type and payment system.

• Requires verification - a payment method has been created, the Travel Rule application needs to be filled in.
• Application submitted - the Travel Rule application has been submitted and is awaiting confirmation.
• Application requires additional info - the Travel Rule application needs to be supplemented.
• Application verified - the application has been verified, the wallet has been added to the whitelist.
• Application rejected - the Travel Rule application has been rejected.
• Payment method deleted - the payment method has been disabled, the wallet has been removed from the whitelist.
• Wallet address added - an administrator has added the wallet address to the whitelist.
• Wallet address deleted - an administrator has removed the wallet address from the whitelist.
• Wallet address disabled - the wallet address has been disabled and removed from the whitelist.