Skip to content

by Startups.Studio

Core grammar Source Integration

Integration.sync

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

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

Noun: Integration
Mode: do
Event: Integration.synced

You, to your agent

Sync the latest integration.

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

import { $ } from 'startup-builder'

const integration = await $.Integration.sync({ integration: 'integration_1' })

npx startup-builder do Integration.sync --json '{"integration":"integration_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Integration.sync({ integration: 'integration_1' })"
  }
}

Inputs

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

Outputs

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

Effects

Emits Integration.synced.
Performed by the Reliability Engineer.
In mirror, an outside edit to a mirrored field is overwritten and recorded as an Action that ends refused.
In import, each outside edit becomes one Change or Action, checked like any other.

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.	Integration.sync
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.	Integration.sync
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.	Integration.sync
The caller sent more requests than its rate allows.	`rate-limited`	Wait the number of seconds in the `Retry-After` header, then retry.	Integration.sync

When it waits

Gate	Default
Decision class	Low: two-way, nothing at stake
Delay window	None: it runs once review passes.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

Integration.revoke

Previous Page

Integration.update

Next Page