Connect Integration

Connect to a source, destination, or embedding model.

Expects a POST body with:

1 {
2     "name": "required connection name",
3     ... other config fields specific to the integration type ...
4 }

Args:

db: The database session. integration_type: The type of integration to connect to. short_name: The short name of the integration to connect to. name: The name of the connection. config_fields: The config fields for the integration. user: The current user.

Returns:

schemas.Connection: The connection.

Path parameters

integration_typeenumRequired

Integration type enum.

Allowed values:

short_namestringRequired

Request

This endpoint expects an object.

config_fieldsmap from strings to anyRequired

namestringOptional

Response

Successful Response

namestring

integration_typeenum

Integration type enum.

Allowed values:

statusenum

Connection status enum.

Allowed values:

short_namestring

idstringformat: "uuid"

integration_credential_idstringOptionalformat: "uuid"

organization_idstringOptionalformat: "uuid"

created_by_emailstringOptional

modified_by_emailstringOptional

1	from airweave import AirweaveSDK
2
3	client = AirweaveSDK(
4	api_key="YOUR_API_KEY",
5	)
6	client.connections.connect_integration(
7	integration_type="source",
8	short_name="short_name",
9	config_fields={"key": "value"},
10	)

1	{
2	"name": "name",
3	"integration_type": "source",
4	"status": "active",
5	"short_name": "short_name",
6	"id": "id",
7	"integration_credential_id": "integration_credential_id",
8	"organization_id": "organization_id",
9	"created_by_email": "created_by_email",
10	"modified_by_email": "modified_by_email"
11	}

Connect Integration

Args:

Returns:

Path parameters

Headers

Request

Response

Errors