Skip to main content

LegacyAlertTopic

Topics are "tags" associated with a particular Alert. Every Alert belongs to one or more different topics, which you can be subscribed to with Craft.

For example, you can be subscribed to Alerts related to "resource:steel" or "company:429" topics.

All the topics are associated with metadata allowing presentation of the topic in a human-readable way.

Example topics:

  • "dataset:news"
  • "class:awards"
  • "resource:steel"
  • "company:429"
  • "location.country:us"
  • "location.region:asia"

You may filter Alerts by topics using the where.topics boolean expression field that supports "eq", "in" and "like" operators. For example:

{ topics: { eq: "company:429" } } { topics: { in: ["company:429", "company:430"] } } { topics: { startsWith: "company" } }

type LegacyAlertTopic {
  topic: String!
  metadata: LegacyJSON!
}

Fields​

LegacyAlertTopic.topic ● String! non-null scalar​

Topic, such as "company:429", "resource:steel", etc. See the "AlertTopic" type description for more details.

LegacyAlertTopic.metadata ● LegacyJSON! non-null scalar​

Metadata associated with a given topic. This is a free-form JSON object that can contain arbitrary metadata. At the same time, you can be sure that at least "name" field in this object will always be present, in case you'll need to present this topic to the end User.

Certain topics will also have "filterName" metadata field in case that topic is needed to be presented in a UI filter, however, this is not guaranteed to be present for all topics, so always add a fallback to the "name" field.

Member Of​

LegacyAlert object