Config V3 schema reference

ConnectorConfigV3 is the source of truth for a Plugsync connector’s configuration. This reference documents every field, the validators that will reject your config, and the workflow that promotes a draft to the live worker pool.

If you are a partner, plugin developer, or self-service customer authoring a connector config without access to the backend repository, this reference plus the two examples in _examples/ is meant to be everything you need.

Top-level shape


{
  "version": "3.0",
  "entities": [],
  "flows": [],
  "settings": {}
}

Where to read next

Page	What’s there
connector.md	Top-level fields (`version`, `entities`, `flows`, `settings`).
entities.md	`EntityV3`, `EntitySchemaSpec`, `IdentityConfig`, `FieldMapping`.
flows.md	`FlowV3` + the dispatch model.
step-actions.md	The 10-action step DSL.
simple-vs-federated.md	The two entity modes and when to pick which.
draft-publish.md	The draft->publish workflow with dashboard screenshots.
examples.md	Two narrated walkthroughs of complete configs.
_examples/	Two copy-pasteable JSON files plus the CI validator.

Prerequisites

Before any of this is useful:

You have a Plugsync org and an authenticated user.
You’ve completed the HubSpot OAuth flow once (so a HubSpot credential exists in your org).
You’ve created a connector via the dashboard or POST /api/connectors.

The connector starts with an empty draft. You author the config you want, review the diff, and publish.

First config in 30 seconds

Copy _examples/compass-light.json, substitute your actual source name where it says compass_inbound, and:


curl -X PATCH https://app.plugsync.com/api/connectors/<id>/draft \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d @compass-light.json

Then open the connector workspace in the dashboard, click “Review changes”, and click “Publish v1”. Your connector is now live.

Out of scope

This reference deliberately does not cover:

Event flow manifest authoring deep-dive (compilation, dedupe). See #ENG-57.
Plugin authoring (Lambda + TypeScript SDK). See #ENG-58 and #190.
v2 schema and v2->v3 migration. v2 is deprecated.
DynamoDB replica internals. See ADR-0014.