Skip to content

by Startups.Studio

Core grammar Source Integration

Integration.refresh

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

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

Noun: Integration
Mode: do
Event: Integration.refreshed

You, to your agent

Refresh the latest integration.

curl -X POST https://api.sb/patentpad.com/integrations/integration_1/refresh \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

import { $ } from 'startup-builder'

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

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

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

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

Inputs

Input	Type	Required	Description
`integration`	Integration	required	The Integration to refresh.

Outputs

Output	Type	Required	Description
`integration`	Integration	required	The Integration with a new `refreshedAt`, or in `needsReauth`.

Effects

Emits Integration.refreshed.
Performed by the Integration Engineer.
Two-way: it runs at once, in the try, send and do modes.
On refusal, holds every Action that needs it pending with reason awaitingSource.
On refusal, opens a Task for the account holder with a reconnect link.

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.	Integration.refresh

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.reconnect

Previous Page

Integration.resume

Next Page