Skip to main content
POST
Connect an integration

Authorizations

Authorization
string
header
required

API key (fam_..., created under Settings → API Keys) or an OAuth 2.0 access token (fam_at_...). REST operations also require API Access for the credential's workspace. Keys can be restricted to scopes such as assistants:read, calls:write, campaigns:write, automations:read, dashboards:read, dashboards:write, leads:write, segments:write, loop:read, loop:write, phone_numbers:write, sip_trunks:write, knowledge:write, voices:read, billing:read, billing:write, settings:write, platform:read, platform:write; a *:write scope implies the matching *:read. Automation and dashboard endpoints also accept the legacy calls:* scope. Keys without scope restrictions have full access within the workspace's available capabilities.

Path Parameters

provider
string
required

Integration id in lower case, for example hostaway. The documentation page of each integration names its id.

Pattern: ^[a-z][a-z0-9_]{1,23}$

Body

application/json
fields
object
required

Connection values by field key. Which keys an integration takes is listed on its documentation page. Secret values (API keys, secrets) are never returned.

name
string

Unique tool name, using letters, numbers and underscores. Defaults to the integration id.

caller_recognition
boolean

Look the caller up in the connected system before the conversation, so the assistant can greet them by name. Defaults to true for integrations that can recognise callers; true is rejected for integrations that cannot. Voice calls use the caller's number; WhatsApp and SMS conversations use the contact's number; email uses a verified sender address.

Response

Created. Secret values are masked.

data
object
required

A reusable tool of the account. Secret values inside config (auth values, header values, Browser Use login password and authenticator key) are always masked as •••.