Member Junction
    Preparing search index...

    Interface IntegrationSyncOptions

    Options for controlling integration sync behavior

    interface IntegrationSyncOptions {
        EntityMapIDs?: string[];
        FullSync?: boolean;
        MaxRuntimeMinutes?: number;
        ScheduledJobRunID?: string;
        SyncDirection?: "Pull" | "Push" | "Bidirectional";
    }
    Index

    Properties

    EntityMapIDs? FullSync? MaxRuntimeMinutes? ScheduledJobRunID? SyncDirection?

    Properties

    EntityMapIDs?: string[]

    Restrict sync to specific entity map IDs. If omitted, all enabled maps are synced.

    FullSync?: boolean

    Force a full sync, ignoring watermarks. Defaults to false.

    MaxRuntimeMinutes?: number

    Expected maximum runtime for this sync, in minutes. Sizes the run's OWNERSHIP LEASE (durable-run claim/renew): the lease is max(engine default, this value), so a run with a known long single batch is not falsely reclaimed as dead by the stale sweep while a batch is still in flight. The lease is renewed on a timer regardless; this only raises the worst-case window a crashed run stays unclaimed. Omit for the engine default.

    ScheduledJobRunID?: string

    Links this sync run to a ScheduledJobRun for traceability.

    SyncDirection?: "Pull" | "Push" | "Bidirectional"

    Override sync direction for all entity maps in this run. If omitted, each entity map's own SyncDirection is used. Pull = external → MJ only. Push = MJ → external only. Bidirectional = both.

    Settings

    Member Visibility

    On This Page

    Properties