Create Integration

POST /api/integrations

Request

{
  "name": "Twilio Production",
  "credentials": {
    "provider": "twilio",
    "account_sid": "ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "auth_token": "your_twilio_auth_token"
  }
}

Response

{
  "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.

Show Twilio Credentials

credentials.provider · string · required

Must be twilio.

credentials.account_sid · string · required

Your Twilio Account SID (starts with AC).

credentials.auth_token · string · required

Your Twilio Auth Token.

Response

success · boolean

Indicates if the request was successful.

message · string

Human-readable success message.

data · object

The created integration object.

Show properties

integration_id · string

Unique integration identifier (format: intg_[a-f0-9]{12}).

client_id · string

The organization/client ID this integration belongs to.

name · string

The name of the integration.

provider · string

The provider type (e.g., twilio).

category · string

The category (e.g., telephony).

status · string

Current status (active or invalid).

created_at · string

ISO 8601 timestamp of creation.

updated_at · string

ISO 8601 timestamp of last update.

Request

{
  "name": "Twilio Production",
  "credentials": {
    "provider": "twilio",
    "account_sid": "ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "auth_token": "your_twilio_auth_token"
  }
}

Response

{
  "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"
  }
}