Membrane SDK - v0.2.1
    Preparing search index...

    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;
        error?: ErrorData;
        isRealTime?: boolean;
        requiresPull?: boolean;
        requiresFullSync?: boolean;
        createdAt?: string;
        archivedAt?: string;
        stateData?: any;
        nextPullEventsTimestamp?: number;
        pullUpdatesIntervalSeconds?: number;
        fullSyncIntervalSeconds?: number;
        nextRefreshTimestamp?: number;
        globalWebhookKey?: string;
        globalWebhookEventSelector?: string;
    }
    Index

    Properties

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

    Properties

    id: string
    name?: string
    userId: string
    user?: Customer
    connectionId: string
    connection?: Connection
    integrationId: string
    integration?: Integration
    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.

    config?: ExternalEventSubscriptionConfig
    status?: ExternalEventSubscriptionStatus
    error?: ErrorData
    isRealTime?: boolean
    requiresPull?: boolean
    requiresFullSync?: boolean
    createdAt?: string
    archivedAt?: string
    stateData?: any

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

    nextPullEventsTimestamp?: number
    pullUpdatesIntervalSeconds?: number

    For subscriptions that pull updates.

    fullSyncIntervalSeconds?: number

    For subscriptions that do full sync.

    nextRefreshTimestamp?: number

    For subscriptions that need refreshing.

    globalWebhookKey?: string

    For subscriptions that use global webhooks.

    globalWebhookEventSelector?: string

    Settings

    Member Visibility

    On This Page

    Properties