Create connector

POST

Create a new connector

Headers

x-org-api-keystringRequired

Request

This endpoint expects an object.

appobjectRequired

Filter options for the connector

configobjectRequired

Filter options for the connector

Response

idstring

List of matched integration ID

integrationIdstring

List of matched integration ID

namestring

Name of the integration

authSchemestring

Auth Scheme of the Integration.

createdAtstring

Date of creation of the integration

updatedAtstring

Date of updation of the integration

enabledboolean

Whether the integration is enabled or not

deletedboolean

Whether the integration is deleted or not

appIdstring

App ID of the integration

appNamestring

App name of the integration

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.

defaultConnectorIdstringOptional

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

POST

1 curl -X POST https://backend.composio.dev/api/v2/integrations/create \
2      -H "x-api-key: <apiKey>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "app": {},
6   "config": {}
7 }'

200Successful

1 {
2   "id": "id",
3   "integrationId": "integrationId",
4   "name": "name",
5   "authScheme": "authScheme",
6   "createdAt": "createdAt",
7   "updatedAt": "updatedAt",
8   "enabled": true,
9   "deleted": true,
10   "appId": "appId",
11   "appName": "appName",
12   "expectedInputFields": [
13     {
14       "name": "name",
15       "type": "type",
16       "description": "description",
17       "display_name": "display_name",
18       "default": {
19         "key": "value"
20       },
21       "required": true,
22       "expected_from_customer": true,
23       "is_secret": true
24     }
25   ],
26   "defaultConnectorId": "defaultConnectorId"
27 }

Get or create connector

Up Next

Built with

1	curl -X POST https://backend.composio.dev/api/v2/integrations/create \
2	-H "x-api-key: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"app": {},
6	"config": {}
7	}'

1	{
2	"id": "id",
3	"integrationId": "integrationId",
4	"name": "name",
5	"authScheme": "authScheme",
6	"createdAt": "createdAt",
7	"updatedAt": "updatedAt",
8	"enabled": true,
9	"deleted": true,
10	"appId": "appId",
11	"appName": "appName",
12	"expectedInputFields": [
13	{
14	"name": "name",
15	"type": "type",
16	"description": "description",
17	"display_name": "display_name",
18	"default": {
19	"key": "value"
20	},
21	"required": true,
22	"expected_from_customer": true,
23	"is_secret": true
24	}
25	],
26	"defaultConnectorId": "defaultConnectorId"
27	}