Custom Integrations — Proposed Guide

Custom Integrations: A custom integration should begin with an ownership and data-contract document rather than a connector implementation. Define how…

Overview

A custom integration should begin with an ownership and data-contract document rather than a connector implementation. Define how source changes become target updates and how exceptions are reviewed.

Key concepts

Specify identifiers, mappings, direction, retry rules and reconciliation evidence. Use fixture contracts before considering transport.

Implementation considerations

This documentation creates no custom connector. Production access and financial actions require separately approved infrastructure and controls.

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.

{
  "reference_only": true,
  "topic": "Custom Integrations",
  "integration_id": "integration_example_123",
  "external_id": "external_example_123",
  "mapping_version": 1,
  "direction": "source-to-target"
}

Design review checklist

• Document which organization owns the custom integrations representation and which actor may view or change it.
• Test the boundaries of integration id, external id, mapping version, direction 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

Related documentation