Magidoc

IntegrationConfigurationInput
Input Object

Input for complete integration configuration.

Field mapping resolution between FieldMappings and AutoMapMode:

  • FieldMappings non-empty: supplied mappings are used; AutoMapMode is silently ignored.
  • FieldMappings empty AND AutoMapMode != None: existing mappings are wiped and replaced by auto-mapped ones for the chosen mode.
  • FieldMappings empty AND AutoMapMode = None: existing mappings are cleared (an empty list is a valid 'clear all' intent).

AutoMapMode is a one-shot trigger only. It is not persisted on the integration. For an unconditional rebuild without touching other configuration, call autoMapIntegrationFields(integrationId, mode) instead.

Fields

#

autoMapMode

Non-null

Auto-map mode. Only honored when FieldMappings is empty in the same call; otherwise ignored (supplied mappings win). One-shot — not persisted. None (default) leaves mappings to the caller. Essentials maps first name, last name, email, address, and timezone, plus any CRM-required or Tarvent-required fields. All maps every CRM field, creating new Tarvent DataFields as needed. Email mappings always get IsTarventMaster=true; all others IsTarventMaster=false (CRM is the data authority).

fieldMappings

Non-null

List of field mappings between integration partner and Tarvent fields. When non-empty, these are used as-is and AutoMapMode is ignored. When empty and AutoMapMode is Essentials or All, the API builds the mappings automatically (replacing any prior mappings).

notificationEmail

Email address for integration notifications

syncFilters

Partner-specific sync filters and settings as JSON string