Skip to main content

@idpass/data-collect-core / ExternalSyncConfig

Type Alias: ExternalSyncConfig

ExternalSyncConfig = object

Defined in: interfaces/types.ts:840

Properties

type

type: string

Defined in: interfaces/types.ts:842

Type of external system (e.g., 'openspp-v2-adapter', 'mock')


auth?

optional auth?: string

Defined in: interfaces/types.ts:844

Authentication method (e.g., 'basic', 'oauth2')


url

url: string

Defined in: interfaces/types.ts:846

URL of the external system


extraFields?

optional extraFields?: ExternalSyncField[]

Defined in: interfaces/types.ts:851

Deprecated

Use adapterConfig instead. Kept for backwards compatibility. Extra fields for the external system as name/value pairs.


adapterConfig?

optional adapterConfig?: Record<string, string | number | boolean>

Defined in: interfaces/types.ts:856

Typed adapter configuration object. Preferred over extraFields for new configurations.


fieldMappings?

optional fieldMappings?: FieldMapping[]

Defined in: interfaces/types.ts:858

Field mappings for data transformation between systems