Skip to main content
POST
Create connection

Authorizations

Authorization
string
header
required

Bearer token authentication using your API key

Body

The details of the connection to create.

config
object
required

Configuration of a connection

name
string

Name for the new connection

Maximum string length: 256
Example:

"My New Connection"

Response

200 - application/json

The newly created connection.

Detailed information about a connection

id
string
required

Unique identifier for the connection

type
enum<string>
required

Connection type

Available options:
SCHEDULER,
WORKFLOWS,
TOOLS,
FILES,
EMAILS,
HTTP_CREDENTIALS,
TABLES,
PAGES,
KNOWLEDGE,
SKILLS,
CONTACTS,
SEGMENTS,
ASSISTANTS,
AGENTS,
CHATS,
INBOX,
MEMBERS,
SUB_ORGS,
BROADCASTS,
ANALYTICS,
AUDIT,
PHONE,
GMAIL,
GOOGLE_SHEETS,
GOOGLE_CALENDAR,
GOOGLE_DRIVE,
GOOGLE_MEET,
ONEDRIVE,
SHAREPOINT,
OUTLOOK_CALENDAR,
OUTLOOK,
AIRTABLE,
NOTION,
LINEAR,
HUBSPOT,
GOHIGHLEVEL,
CAL,
CALENDLY,
RESEND,
OAUTH,
SLACK,
TEAMS,
TELEGRAM,
TRELLO,
FACEBOOK,
WHATSAPP,
INSTAGRAM,
MESSENGER,
TIKTOK,
JAPIFON,
SMPP,
TWILIO,
TELNYX,
ZOHO,
ZOHO_BOOKINGS,
ZOHO_INVENTORY,
ZOHO_CALENDAR,
SALESFORCE,
STRIPE,
SHOPIFY,
ZENDESK,
MCP,
OPENAPI,
ODOO,
WOOCOMMERCE
Example:

"SLACK"

name
string | null
required

Optional name for the connection

Example:

"My Encompass Connection"

external_name
string | null
required

Optional external name for the connection

external_id
string | null
required

Optional external identifier for the connection

status
enum<string>
required
Available options:
ACTIVE,
INACTIVE
status_error
string | null
required

Optional error message if the connection is in error state

config
object
required

Configuration of a connection

created_at
string<date-time> | null
required

Timestamp of when the connection was created

updated_at
string<date-time> | null
required

Timestamp of when the connection was last updated

email_identity
object

An email identity