Skip to content
StartupBuilder
by startups.studio
by Startups.Studio
Code
Changelog
APICore grammarSourceIntegration

Integration routes: reconnect, refresh, resume, revoke

The Integration Verbs reconnect, refresh, resume, revoke as api.sb routes, with inputs, result, refusals and an example.

Reference for Integration, one group of Integration routes.

Integration.reconnect

Reconnect re-approves an Integration in place, keeping its id and cursor, so nothing re-imports. Verb page.

Text
POST /{namespace}/integrations/{integration}/reconnect

Path: integration. Emits Integration.reconnected.

Inputs

InputTypeRequiredDescription
integrationIntegrationrequiredThe Integration in needsReauth.

Returns

OutputTypeRequiredDescription
connectUrlurlrequiredThe approval page; it expires in one hour.
integrationIntegrationrequiredThe Integration, its id and cursor kept.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/integrations/integration_alVwjQcmRy/reconnect \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "connectUrl": "https://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.reconnect",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Integration.refresh

Refresh renews an Integration’s outside token before it expires; a refused refresh moves it to needsReauth. Verb page.

Text
POST /{namespace}/integrations/{integration}/refresh

Path: integration. Emits Integration.refreshed.

Inputs

InputTypeRequiredDescription
integrationIntegrationrequiredThe Integration to refresh.

Returns

OutputTypeRequiredDescription
integrationIntegrationrequiredThe Integration with a new refreshedAt, or in needsReauth.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/integrations/integration_alVwjQcmRy/refresh \
  -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.refresh",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Integration.resume

Resume restarts a paused Integration from its cursor and releases the Actions that waited on it. Verb page.

Text
POST /{namespace}/integrations/{integration}/resume

Path: integration. Emits Integration.resumed.

Inputs

InputTypeRequiredDescription
integrationIntegrationrequiredThe paused Integration.

Returns

OutputTypeRequiredDescription
integrationIntegrationrequiredThe Integration, connected.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/integrations/integration_alVwjQcmRy/resume \
  -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.resume",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Integration.revoke

Revoke ends an Integration at once: its token is revoked with the upstream, and every record it brought in stays. Verb page.

Text
POST /{namespace}/integrations/{integration}/revoke

Path: integration. Body, as JSON: the other inputs. Emits Integration.revoked.

Inputs

InputTypeRequiredDescription
integrationIntegrationrequiredThe Integration to end.
reasontextWhy, kept on the Integration.

Returns

OutputTypeRequiredDescription
integrationIntegrationrequiredThe Integration, revoked.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/integrations/integration_alVwjQcmRy/revoke \
  -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.revoke",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

call, connect, pause

Previous

sync

Next