Connections

Create Connection

QuickBooks and Mercury: returns a pending connection — complete the OAuth flow to activate (Mercury may instead connect at once with a personal API token where the deployment allows it). External: registers a source namespace for an integration that writes through the public API. One connection allowed per provider per graph, except 'external' which allows one per source_name and 'plaid' which allows one per bank login (a connection still waiting on Link is returned instead of a second). Plaid: returns a pending connection — POST /oauth/init returns a link_token for Plaid Link. A bank feed (Mercury, Plaid) names the entity its accounts book to (entity_id, the group parent when omitted) and is refused (409) when that entity has no chart of accounts or is the one QuickBooks keeps; QuickBooks is refused (409) when the group parent's books are already native.

post/v1/graphs/{graph_id}/connections

Request

  • Base URL: https://api.robosystems.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.robosystems.ai/v1/graphs/{graph_id}/connections
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

graph_idstring required

Request body

provider'quickbooks' | 'external' | 'mercury' | 'plaid' required

Connection provider type

entity_idstring nullable

Entity identifier. Required for QuickBooks.

Response

Successful Response

connection_idstring required

Unique connection identifier

providerstring required

Connection provider type

entity_idstring nullable

Entity identifier

statusstring required

Connection status

write_policystring nullable

Source-of-truth write policy: 'native' (RoboSystems is authoritative; no outbound write-back) or 'qb_authoritative' (QuickBooks is authoritative; RoboSystems-originated entries publish to QB). Set via the write-policy endpoint.

source_namestring nullable

External-provider registered source slug — the value the integration stamps on the events it emits. Null for platform providers.

metadataobject required

Provider-specific metadata

Changes

No recorded changes to this operation across all 1 revision of this API.