News API

List the pending calendar alerts of the project

Changed on

Contains the manually armed bells as well as the advance warnings materialised from the news features.

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

Request

  • Base URL
    https://api.metacopier.io
  • Auth
    API key in header X-API-KEY

Path parameters

projectIdstring uuid required

Response

OK

accountIdstring uuid

Account the warning is about, null for a plain calendar reminder

createdAtstring date-time

Creation time

createdByEmailstring

Who armed the row, provenance only and never a scope

eventIdstring

Id of the calendar event this alert points at

eventTimeUtcstring date-time

Event time the fire time was computed from

eventTitlestring

Event title at arming time, for the alert list

featureIdstring uuid

Originating news feature instance, null for a bell

fireAtUtcstring date-time

When the alert becomes due

idstring

MongoDB document id

kind'BELL' | 'RULE' | 'FILTER_WARNING' | 'AGENDA'

Which producer created the row

leadMinutesinteger

Minutes before the event the alert fires

projectIdstring uuid

Owning project

ruleIdstring

Originating standing rule, null unless kind is RULE

sentboolean

True once the alert has been claimed and dispatched

Example response

[
  {
    "leadMinutes": 15,
    "notificationTargets": [
      {
        "recipient": "@john"
      }
    ]
  }
]

Changes