Skip to content

Connector Template

Use this for connectors and adapters (e.g., Stripe, SendGrid, Twilio, Google Ads). Connectors are plugins in the shared Connector Runtime, not standalone services. They align with the Integration Platform.

Template

# <Provider> Connector (CS-SVC-XXXX)

## Provider & Capability
What external system, and which operations are supported.

## Direction
- Inbound (ingest) | Outbound (push) | Bidirectional.

## Authentication
- OAuth2 / API key / mTLS; where credentials are stored (credential vault).

## Contract Mapping
- External model -> internal canonical model (anti-corruption layer).

## Events & Sync
- Webhooks consumed; events emitted; sync strategy and idempotency.

## Rate Limits & Resilience
- Provider limits, retries, backoff, circuit breaking.

## Observability
- Health, latency, failure metrics surfaced to the integration dashboard.