Class SubscriptionCreateRequest

New webhook settings for an app.

Constructors

constructor

Properties

active? eventType objectTypeId? propertyName? attributeTypeMap discriminator mapping

Methods

getAttributeTypeMap

Constructors

constructor

Properties

Optionalactive

active?: boolean

Determines if the subscription is active or paused. Defaults to false.

eventType

eventType: SubscriptionCreateRequestEventTypeEnum

Type of event to listen for. Can be one of create, delete, deletedForPrivacy, or propertyChange.

OptionalobjectTypeId

objectTypeId?: string

OptionalpropertyName

propertyName?: string

The internal name of the property to monitor for changes. Only applies when eventType is propertyChange.

Static ReadonlyattributeTypeMap

attributeTypeMap: {
    baseName: string;
    format: string;
    name: string;
    type: string;
}[] = ...

Static Readonlydiscriminator

discriminator: undefined | string = undefined

Static Readonlymapping

mapping: undefined | {
    [index: string]: string;
} = undefined

Methods

StaticgetAttributeTypeMap

  • getAttributeTypeMap(): {
        baseName: string;
        format: string;
        name: string;
        type: string;
    }[]

  • Returns {
        baseName: string;
        format: string;
        name: string;
        type: string;
    }[]

Settings

Member Visibility

On This Page

Constructors
Properties
Methods