Skip to content

by Startups.Studio

Core grammar Source Integration

Integration.pause

POST /{namespace}/integrations/{integration}/pause

Pause stops every call through an Integration at once and keeps its token and cursor.

Noun: Integration
Mode: do
Event: Integration.paused

You, to your agent

Pause the latest integration.

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

import { $ } from 'startup-builder'

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

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

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

Inputs

Input	Type	Required	Description
`integration`	Integration	required	The Integration to pause.
`reason`	`text`		Why, shown to every Worker whose Action waits on it.

Outputs

Output	Type	Required	Description
`integration`	Integration	required	The Integration, `paused`.

Effects

Emits Integration.paused.
Two-way: it runs at once, in the try, send and do modes.
Holds every Action that needs it pending with reason awaitingSource.

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

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

Previous Page

Integration.reconnect

Next Page