Sign in
News API

List the standing calendar alert rules of the project

get/rest/api/v1/projects/{projectId}/calendarAlertRules

Path parameters

projectIdstring uuid required

Response

OK

createdAtstring date-time

Creation time

createdByEmailstring

Who created the rule, provenance only and never a scope

currencyCodesstring[]

Currencies the rule reacts to. Empty matches every currency.

enabledboolean

A disabled rule stops materialising new alerts

idstring

MongoDB document id

includeMarketNewsboolean

Also send HIGH impact market news headlines matching the currencies of this rule. Those have no lead time, they are announced when they are summarised.

leadMinutesinteger[]

Minutes before the event the alerts fire

minImpact'HOLIDAY' | 'LOW' | 'MEDIUM' | 'HIGH'

Lowest impact the rule reacts to

namestring

Label shown in the alerts panel

projectIdstring uuid

Owning project

Example response

[
  {
    "leadMinutes": [
      30
    ],
    "name": "High impact USD",
    "notificationTargets": [
      {
        "recipient": "@john"
      }
    ]
  }
]

Changes

Changed in 1 of the 3 revisions of this API.1