Skip to main content
POST
/
api
/
integrations
{
  "name": "Twilio Production",
  "credentials": {
    "provider": "twilio",
    "account_sid": "ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "auth_token": "your_twilio_auth_token"
  }
}

{
  "success": true,
  "message": "Integration created successfully",
  "data": {
    "integration_id": "intg_a1b2c3d4e5f6",
    "client_id": "org_abc123",
    "name": "Twilio Production",
    "provider": "twilio",
    "category": "telephony",
    "status": "active",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z"
  }
}
Create a new integration with external service credentials (e.g., Twilio). Integrations enable your agents to make and receive calls through your own telephony provider accounts.

​
Headers

​
X-API-Key
string
required
Your API key for authentication.
​
X-Organization-Id
string
required
The organization ID.
​
Content-Type
string
required
Must be application/json.

​
Permissions

  • integrations:create (admin, agent_manager)

​
Request Body

​
name
string
required
A human-readable name for the integration (1-100 characters).
​
credentials
object
required
Provider-specific credentials object. The structure depends on the provider.

​
Response

​
success
boolean
Indicates if the request was successful.
​
message
string
Human-readable success message.
​
data
object
The created integration object.
{
  "name": "Twilio Production",
  "credentials": {
    "provider": "twilio",
    "account_sid": "ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "auth_token": "your_twilio_auth_token"
  }
}

{
  "success": true,
  "message": "Integration created successfully",
  "data": {
    "integration_id": "intg_a1b2c3d4e5f6",
    "client_id": "org_abc123",
    "name": "Twilio Production",
    "provider": "twilio",
    "category": "telephony",
    "status": "active",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z"
  }
}