MEmetacopier
Notifications API

Send a sample event to every target of a rule

Changed on

The rule does not need to be saved. Filters, digest, quiet hours and cooldown are bypassed.

post/rest/api/v1/projects/{projectId}/notificationRules/test

Request

Path parameters

projectIdstring uuid required

Request body

accountIdstring uuid

Optional account used in the sample message

event'POSITION_OPENED' | 'POSITION_CLOSED' | 'POSITION_MODIFIED' | 'HISTORY_UPDATED' | 'TRADE_APPROVAL_REQUIRED' | 'TRADE_APPROVED' | 'UNMANAGED_POSITION_DETECTED' | 'COPY_SKIPPED' | 'ORDER_REJECTED' | 'INSUFFICIENT_MARGIN' | 'TRADE_FAILED_DISCONNECTED' | 'COPY_FAILED' | 'DUPLICATE_POSITION_DETECTED' | 'ACCOUNT_STARTED' | 'ACCOUNT_STOPPED' | 'ACCOUNT_CONNECTED' | 'ACCOUNT_DISCONNECTED' | 'ACCOUNT_LOGIN_FAILED' | 'ACCOUNT_TOKEN_EXPIRING' | 'ACCOUNT_RESTRICTED' | 'ACCOUNT_FALLBACK_MODE' | 'RISK_LIMIT_REACHED' | 'PROFIT_TARGET_REACHED' | 'LOSS_PROTECTED_EXIT' | 'GUARDRAIL_TRIGGERED' | 'COPIER_STOPPED_BY_RISK' | 'LIMIT_RESET' | 'BALANCE_ADJUSTMENT_DETECTED' | 'NEWS_EVENT_UPCOMING' | 'NEWS_EVENT_RELEASED' | 'NEWS_FILTER_ACTION_SCHEDULED' | 'NEWS_FILTER_ACTION_IMMINENT' | 'NEWS_FILTER_DAILY_AGENDA' | 'NEWS_FILTER_SKIPPED_COPY' | 'NEWS_FILTER_CLOSED_POSITION' | 'NEWS_FILTER_REOPENED' | 'NEWS_FILTER_REOPEN_SKIPPED' | 'NEWS_FILTER_HOLIDAY_MODE' | 'MARKET_NEWS_HIGH_IMPACT' | 'SIGNAL_RECEIVED' | 'SIGNAL_EXECUTED' | 'SIGNAL_REJECTED' | 'SIGNAL_AI_LIMIT_REACHED' | 'SIGNAL_SUBSCRIPTION_ENDED' | 'CONFIGURATION_ERROR' | 'CONFIGURATION_CHANGED' | 'MAINTENANCE_WINDOW' | 'PROXY_ISSUE' | 'EXPERT_ADVISOR_STARTED' | 'EXPERT_ADVISOR_STOPPED' | 'EXPERT_ADVISOR_WARNING' | 'LOG_RATE_LIMITED' | 'NOTIFICATION_CHANNEL_DISABLED' | 'GENERAL'

Sample event, default POSITION_OPENED

Example request

{
  "rule": {
    "cooldown": {
      "minutes": 15
    },
    "digest": {
      "windowSeconds": 60
    },
    "kind": "RULE",
    "name": "Errors to Teams",
    "quietHours": {
      "after": "SUMMARY",
      "from": "22:00",
      "timeZone": "Europe/Zurich",
      "to": "07:00"
    },
    "targets": [
      {
        "recipient": "@john"
      }
    ]
  }
}

Response

OK

Changes