Create connector

API key for authentication, you can easily get it from the dashboard after login or if you are using CLI, you can get it from the composio whoami command

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

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

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

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

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.

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.

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.

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

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

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

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.

URL to the application's logo image that can be displayed in the UI.

The name of the application this connector integrates with.

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

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

The authentication method used by this connector. Refer to the API documentation for supported authentication schemes.

The display name of this specific connector configuration.

ISO 8601 timestamp of when this connector was created.

ISO 8601 timestamp of when this connector was last modified.

Soft deletion status of the connector. If true, the connector has been marked for deletion but may still exist in the system.

If this is a custom connector, this field may reference the original template connector it was based on.