Skip to main content
POST
/
orgs
/
{org_id}
/
connections
Create User Connection
curl --request POST \
  --url https://api.example.com/orgs/{org_id}/connections \
  --header 'Content-Type: application/json' \
  --data '
{
  "config": {
    "type": "PHONE",
    "auth_method": "MANUAL",
    "phone": "<string>",
    "code": 123
  },
  "name": "My New Connection"
}
'
{
  "id": "<string>",
  "type": "SLACK",
  "name": "My Encompass Connection",
  "external_name": "<string>",
  "external_id": "<string>",
  "status": "ACTIVE",
  "status_error": "<string>",
  "config": {
    "type": "PHONE",
    "auth_method": "MANUAL",
    "phone": "<string>",
    "code": 123
  },
  "created_at": "2023-12-25",
  "updated_at": "2023-12-25"
}

Path Parameters

​
org_id
string
required

Body

The details of the connection to create.

​
config
object
required

Configuration of a connection

​
name
string

Name for the new connection

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,
PHONE,
GMAIL,
GOOGLE_SHEETS,
GOOGLE_CALENDAR,
AIRTABLE,
NOTION,
LINEAR,
HUBSPOT,
GOHIGHLEVEL,
CAL,
CALENDLY,
RESEND,
OAUTH,
SLACK,
TELEGRAM,
TRELLO,
FACEBOOK,
WHATSAPP,
INSTAGRAM,
MESSENGER,
JAPIFON,
TWILIO,
ZOHO,
SALESFORCE,
STRIPE,
SHOPIFY,
ZENDESK,
MCP
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> | null
required

Timestamp of when the connection was created

​
updated_at
string<date> | null
required

Timestamp of when the connection was last updated