Integrations

Complete the setup of a connection

POST
/integrations/connections/{connection_id}/setup

Store the setup selection of a connection, chosen from integrations.connections.setup_options. With space_id it also creates a grant for that Space with every offered operation, unless one already exists.

Authorization

bearerApiKey
AuthorizationBearer <token>

Create a scoped API key in the Adlass settings.

In: header

Path Parameters

connection_id*string

Resource identifier: connection_id.

Formatuuid

Header Parameters

X-Request-Id?string

Optional correlation identifier.

Lengthlength <= 128
Idempotency-Key*string

A unique key for this intended write. Reuse it only for an identical retry.

Length1 <= length <= 200

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://example.com/integrations/connections/123e4567-e89b-42d3-a456-426614174000/setup" \  -H "Idempotency-Key: 123e4567-e89b-42d3-a456-426614174000" \  -H "Content-Type: application/json" \  -d '{    "selection": {}  }'
{  "connection": {    "id": "123e4567-e89b-42d3-a456-426614174000",    "provider_key": "klaviyo",    "auth_scheme": "example",    "label": "Customer documents",    "external_identity": "example",    "public_config": {},    "status": "ACTIVE",    "enabled": false,    "safe_error_code": "example",    "test_summary": {},    "provider_contract_digest": "example",    "last_tested_at": "example",    "created_at": "example",    "updated_at": "example",    "setup_required": false,    "offered_operations": [],    "scope": {}  },  "grant_id": "example",  "existing_grant_id": "example"}