API Referencev1Integrations

Create connector

Create a new connector

Headers

x-api-keystringRequired

Request

CreateConnectorPayloadDTO
namestringRequired
A unique name for your connector. This will be used to identify the connector in the system.
authSchemestringOptional

The authentication scheme used by the connector. Refer to the /api/v1/apps endpoint to see supported authentication schemes for each app.

authConfigobjectOptional

Configuration options for authentication. Required when using OAuth-based authentication schemes.

useComposioAuthbooleanOptional

When set to true, the connector will use Composio’s built-in authentication system. Learn more in the Authentication section of the API documentation.

appIdstringOptional

UUID of the Composio app to use for authentication. You can get this from the id field in the response of the GET /api/v1/apps endpoint. Either specify this or appName.

appNamestringOptional

Name of the Composio app to use for authentication. You can get this from the name field in the response of the GET /api/v1/apps endpoint. Either specify this or appId.

forceNewIntegrationbooleanOptional
When set to true, creates a new integration even if one already exists for the given app. This is useful when you need multiple integrations with the same service.
limitedActionslist of stringsOptional
List of actions to limit the connector to. If not provided, all actions will be enabled.

Response

enabledboolean
Whether this connector is currently active and can be used to create new connections. Can be toggled using the connector management endpoints.
appIdstring

The ID of the application this connector belongs to. You can find available apps using the GET /api/v1/apps endpoint.

authConfigobject
Configuration object containing authentication settings. Sensitive values will be redacted. The structure varies based on the authScheme.
expectedInputFieldslist of objects

List of fields that need to be collected from users to set up a connection using this connector. These fields should be included when calling POST /api/v1/connectedAccounts.

appNamestring
The name of the application this connector integrates with.
useComposioAuthboolean

When true, indicates that this connector uses Composio’s built-in authentication handling rather than custom authentication logic.

limitedActionslist of strings
Array of action strings that this connector is limited to.
idstring or null

Unique identifier for the connector. You can use this ID when calling endpoints like POST /api/v1/connectedAccounts to create connections.

authSchemestring or null
The authentication method used by this connector. Refer to the API documentation for supported authentication schemes.
namestring or null
The display name of this specific connector configuration.
createdAtstring or nullformat: "\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d.\d+Z?"
ISO 8601 timestamp of when this connector was created.
updatedAtstring or nullformat: "\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d.\d+Z?"
ISO 8601 timestamp of when this connector was last modified.
deletedboolean or null
Soft deletion status of the connector. If true, the connector has been marked for deletion but may still exist in the system.
defaultConnectorIdstring or null
If this is a custom connector, this field may reference the original template connector it was based on.