Integration Configuration — Proposed Guide

Planned API — Reference Only

Integration Configuration: Configuration would specify which entities and record types a future connector handles. It should not hide synchronization…

Overview

Configuration would specify which entities and record types a future connector handles. It should not hide synchronization direction or destructive update behavior behind a single enabled flag.

Key concepts

Version field mappings, include filters and choose conflict rules. Validate provider-side entity references.

Implementation considerations

Saving a proposed configuration is not activation. An eventual deployment needs approved authorization and separately tested data-transfer behavior.

Illustrative data model

This local fixture shows a possible representation for the concepts above. It is not an endpoint response, production configuration or a claim that the described capability is implemented.

JSON fixture

Fictional concept fixture

{
  "reference_only": true,
  "topic": "Integration Configuration",
  "integration_id": "integration_example_123",
  "direction": "source-to-target",
  "subsidiary_id": "sub_example_123",
  "mapping_version": 1
}

Design review checklist

Document which organization owns the integration configuration representation and which actor may view or change it.
Test the boundaries of integration id, direction, subsidiary id, mapping version using synthetic values, including missing or inconsistent references.
Before future implementation, obtain an approved contract and review failure behavior. This documentation does not authorize production activation.

Proposed data types

Illustrative field dictionary
Name	Type	Description
integration_id	string	Stable fictional integration reference; not a secret and not evidence that a resource exists.
direction	string	Proposed data flow direction, independent of record ownership and connector activation.
subsidiary_id	string	Stable fictional subsidiary reference; not a secret and not evidence that a resource exists.
mapping_version	integer	Revision of the source-to-target field transformation used for this representation.

Integration Authentication

Integrations

Integration Status