Skip to content

by Startups.Studio

Handle.connect

POST /{namespace}/handles/{handle}/connect

Connect binds a Handle to the Integration credential it publishes through, once the platform confirms the account.

Noun: Handle
Mode: do
Event: Handle.connected

You, to your agent

Connect the latest handle with an integration.

curl -X POST https://api.sb/tutorloop.com/handles/handle_1/connect \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"integration":"integration_1"}'

import { $ } from 'startup-builder'

const handle = await $.Handle.connect({ handle: 'handle_1', integration: 'integration_1' })

npx startup-builder do Handle.connect --json '{"handle":"handle_1","integration":"integration_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Handle.connect({ handle: 'handle_1', integration: 'integration_1' })"
  }
}

Inputs

Input	Type	Required	Description
`handle`	Handle	required	The Handle.
`integration`	Integration	required	The Integration credential.

Outputs

Output	Type	Required	Description
`handle`	Handle	required	The connected Handle.

Effects

Emits Handle.connected.
Performed by the Content Lead.
Two-way: it runs at once, in the try, send and do modes.

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.	Handle.connect

When it waits

Gate	Default
Decision class	Medium: two-way, visible
Delay window	1 business hour, in which a watcher can pause, redirect or cancel it; then it runs.
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`.

Handle

Previous Page

Handle.create

Next Page