Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface NotificationEventField

Encapsulates the properties of a filterable field. A filterable field is a field in an event that can used to filter notifications for a certain event type.

Hierarchy

  • NotificationEventField

Index

Properties

Optional fieldType

Gets or sets the type of this field.

Optional id

id: string

Gets or sets the unique identifier of this field.

Optional name

name: string

Gets or sets the name of this field.

Optional path

path: string

Gets or sets the path to the field in the event object. This path can be either Json Path or XPath, depending on if the event will be serialized into Json or XML

Optional supportedScopes

supportedScopes: Array<string>

Gets or sets the scopes that this field supports. If not specified then the event type scopes apply.

Generated using TypeDoc