Interface ExternalEventSubscription

interface ExternalEventSubscription {
    id: string;
    name?: string;
    userId: string;
    user?: Customer;
    connectionId: string;
    connection?: Connection;
    integrationId: string;
    integration?: Integration;
    uuid: string;
    config?: ExternalEventSubscriptionConfig;
    status?: ExternalEventSubscriptionStatus;
    isRealTime?: boolean;
    requiresPull?: boolean;
    requiresFullSync?: boolean;
    error?: ErrorData;
    createdAt?: string;
    archivedAt?: string;
    stateData?: any;
    nextPullEventsTimestamp?: number;
    pullUpdatesIntervalSeconds?: number;
    fullSyncIntervalSeconds?: number;
    nextRefreshTimestamp?: number;
    globalWebhookKey?: string;
    globalWebhookEventSelector?: string;
}

Properties

id name? userId user? connectionId connection? integrationId integration? uuid config? status? isRealTime? requiresPull? requiresFullSync? error? createdAt? archivedAt? stateData? nextPullEventsTimestamp? pullUpdatesIntervalSeconds? fullSyncIntervalSeconds? nextRefreshTimestamp? globalWebhookKey? globalWebhookEventSelector?

Properties

id

id: string

Optionalname

name?: string

userId

userId: string

Optionaluser

user?: Customer

connectionId

connectionId: string

Optionalconnection

connection?: Connection

integrationId

integrationId: string

Optionalintegration

integration?: Integration

uuid

uuid: string

Globally unique identifier of the subscription that is hard to guess. Used for webhooks and other cases where we need to identify the subscription.

Optionalconfig

config?: ExternalEventSubscriptionConfig

Optionalstatus

status?: ExternalEventSubscriptionStatus

OptionalisRealTime

isRealTime?: boolean

OptionalrequiresPull

requiresPull?: boolean

OptionalrequiresFullSync

requiresFullSync?: boolean

Optionalerror

error?: ErrorData

OptionalcreatedAt

createdAt?: string

OptionalarchivedAt

archivedAt?: string

OptionalstateData

stateData?: any

For subscriptions that store state in between pulls/refreshes/runs.

OptionalnextPullEventsTimestamp

nextPullEventsTimestamp?: number

OptionalpullUpdatesIntervalSeconds

pullUpdatesIntervalSeconds?: number

For subscriptions that pull updates.

OptionalfullSyncIntervalSeconds

fullSyncIntervalSeconds?: number

For subscriptions that do full sync.

OptionalnextRefreshTimestamp

nextRefreshTimestamp?: number

For subscriptions that need refreshing.

OptionalglobalWebhookKey

globalWebhookKey?: string

For subscriptions that use global webhooks.

OptionalglobalWebhookEventSelector

globalWebhookEventSelector?: string

Settings

Member Visibility

On This Page

Properties