Integration commands: create, get
The Integration Verbs create, get as CLI commands, with inputs, result, refusals and an example.
Reference for Integration, one group of Integration commands.
Integration.create
Creates an Integration. Verb page.
npx startup-builder do Integration.create --json '<input>' [--try | --send | --do]Emits Integration.created.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
acquired | string | required | One of owned, wrapped, or recruited. |
terms | text | The terms the Startup holds the right to use and resell it under. | |
scope | string | required | One of studio, startup, or customer. |
sync | string | Which side leads a sync connector: platform or provider. | |
mode | string | required | How records move: mirror writes db.sb out to the outside tool; import turns edits there into Changes. db.sb is the record in both. |
venue | string | The id of the ad, social or app-store venue the account is on, when it is on one. | |
account | string | The outside account’s own id, such as an ad account, a workspace or a repository. | |
grants | string[] | The outside permissions the account holder approved: the narrowest set its Verbs need. | |
connectedBy | Party | Who approved the connection; a Human’s own account is used only under that Human’s Mandate. | |
environment | string | A test Integration reaches only the upstream’s test account, as a Stripe test account does. | |
expiresAt | datetime | When access lapses unless refreshed. | |
refreshedAt | datetime | When the platform last renewed the outside token. | |
lastError | string | The error slug of the last failed call or refresh, cleared by the next success. | |
cursor | string | Where the last sync run stopped, so the next run reads only what changed. | |
system | System | An Integration connects an outside Source to one System, with credentials at Studio, Startup or Customer scope. | |
source | Source | an Integration binds one wrapped Source to a System with credentials. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
integration | Integration | required | The Integration. |
Refuses when
| Check | Error | Fix | Then call |
|---|---|---|---|
| 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. |
Example
npx startup-builder do Integration.create --json '{"acquired":Integration.get
Returns one Integration by id. Verb page.
npx startup-builder do Integration.get --json '<input>' [--try]Reads only: it emits no Event.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Integration. |
at | string | A time or Version name: the record as it stood then. Unset: as it stands now. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
integration | Integration | required | The Integration. |
Refuses when
| Check | Error | Fix | Then call |
|---|---|---|---|
| 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. |
Example
npx startup-builder do Integration.get --json '{"id":