connectors

Create connector

Creates a connector in an environment.

The configuration is validated for the connector type, and credential fields are stored encrypted. Names used by connectors defined in code return 409.

Required permission: connectors.create. Passing agent_name also requires connectors.link.

post/v1/projects/{project_id}/connectors

Request

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

Path parameters

project_idstring uuid required

ID of the project the API key belongs to.

Query parameters

environment_idstring uuid required

Environment to create the connector in.

agent_namestring nullable

Agent to link to the new connector in the same request.

Request body

domain_idstring uuid nullable

Active custom domain of the project for the connector's URL. Not every connector type supports one.

namestring required

Must not match a connector defined in code in the same environment.

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

Configuration for the connector type, with the fields documented on that connector's docs page. For types that use Connections, connection_id reuses saved credentials, and credentials sent inline are stored in a matching or new Connection. Secrets such as webhook secrets are generated by Connic.

enabledboolean

Set to false to create the connector paused. Some inbound stream connectors start paused unless this is sent, and any connector starts paused when the plan's active connector limit is reached.

Response

Successful Response

idstring uuid required
project_idstring uuid required

Project the connector belongs to.

environment_idstring uuid required

Environment the connector runs in.

domain_idstring uuid nullable

Custom domain the connector's URL uses, or null for the default connector host.

namestring required
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

Configuration for the connector type, with the fields documented on that connector's docs page. Credential fields are masked as ********; secrets Connic generates for the connector, such as webhook secrets, are returned in full.

enabledboolean required

False while the connector is paused. A paused connector starts no new runs.

created_atstring date-time required
updated_atstring date-time required
managed_keystring nullable

Key of the connectors/<key>.yaml file that defines this connector in code, or null. Change these connectors in your codebase; the API can only pause or resume them.

retired_atstring date-time nullable

When the active deployment stopped declaring this connector in code, or null. Retired connectors stay paused until a deployment declares them again, and can be deleted.

Changes

No recorded changes to this operation across all 1 revision of this API.