Integration routes: sync · StartupBuilder

Reference for Integration, one group of Integration routes.

Integration.sync

Sync exchanges records between a System and its connector, and the declared leader wins every conflict. Verb page.

Text

POST /{namespace}/integrations/{integration}/sync

Path: integration. Emits Integration.synced.

Inputs

Input	Type	Required	Description
`integration`	Integration	required	The connector to sync.

Returns

Output	Type	Required	Description
`integration`	Integration	required	The Integration with its sync cursor moved.

Refuses when

Check	Error	Fix	Then call
The request carries no key, or its key is expired or revoked.	`unauthorized`	Sign in again, or send a current key as a bearer token.	None.
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.
The record is not in a state that allows this Verb, so the call is refused.	`refused`	Read the record, run the Verb that moves it to an allowed state, then retry.	None.
The caller sent more requests than its rate allows.	`rate-limited`	Wait the number of seconds in the `Retry-After` header, then retry.	None.

Example

Terminal

curl -X POST https://api.sb/leaseline.app/integrations/integration_alVwjQcmRy/sync \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

JSON

{
  "api": "https://api.sb/leaseline.app",
  "integration": {
    "$id": "https://api.sb/leaseline.app/integrations/integration_alVwjQcmRy",
    "$type": "Integration",
    "acquired": "owned",
    "scope": "studio",
    "mode": "mirror",
    "state": "connecting"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Integration.sync",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Integration.syncCopy Anchor Link

Integration.sync