connections

Create connection

Create a reusable set of credentials for the project.

Connector types that need an app setup flow return 400 and must be connected in the dashboard.

Required permission: connections.create.

post/v1/projects/{project_id}/connections

Request

  • Base URL: https://api.connic.co
  • URL: https://api.connic.co/v1/projects/{project_id}/connections
  • Auth: HTTP bearer

Path parameters

project_idstring uuid required

ID of the project the API key belongs to.

Request body

namestring required

Unique per connection type in the project.

type'http' | 'cron' | 'kafka' | 'sqs' | 'postgres' | 'websocket' | 'mcp' | 'email' | 's3' | 'stripe' | 'telegram' | 'slack' | 'twilio' | 'twilio_messaging' | 'telnyx' | 'telnyx_messaging' required

Connector type, which sets the event source or destination and the fields accepted in config.

configobject required

Credential fields from GET /connections/-/schema/{connector_type}. Other fields are dropped.

Response

Successful Response

idstring uuid required
project_idstring uuid required

Project the connection belongs to.

namestring required
typestring required

Connection type. Related connector types that share credentials use the same type.

configobject required

Credential fields, with secret fields masked as ********.

created_atstring required
updated_atstring required
connector_idsstring[]

IDs of the connectors that use this connection, in any environment.

Changes

No recorded changes to this operation across all 2 revisions of this API.