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.

interface NotificationEventField {
    fieldType?: NotificationEventFieldType;
    id?: string;
    name?: string;
    path?: string;
    supportedScopes?: string[];
}

Properties

fieldType? id? name? path? supportedScopes?

Properties

OptionalfieldType

fieldType?: NotificationEventFieldType

Gets or sets the type of this field.

Optionalid

id?: string

Gets or sets the unique identifier of this field.

Optionalname

name?: string

Gets or sets the name of this field.

Optionalpath

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

OptionalsupportedScopes

supportedScopes?: string[]

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

Settings

Member Visibility

On This Page

Properties