Handle methods: connect
The Handle Verbs connect as typed SDK methods, with inputs, result, refusals and an example.
Reference for Handle, one group of Handle methods.
Handle.connect
Connect binds a Handle to the Integration credential it publishes through, once the platform confirms the account. Verb page.
interface HandleVerbs {
connect(input: HandleConnectInput, options?: SB.CallOptions): SB.Call<Handle>
}Emits Handle.connected.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
handle | Handle | required | The Handle. |
integration | Integration | required | The Integration credential. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
handle | Handle | required | The connected Handle. |
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
import { $ } from 'startup-builder'
const handle = await $.Handle.connect({ handle: 'handle_FcnNwYQujc', integration: 'integration_alVwjQcmRy' })