Skip to main content
POST
create-connector

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
name
string
required
key
string
logoUri
string
externalAppId
string
externalAppUuid
string
appUuid
string

[INTERNAL] Deprecated: resolved to externalAppId

categories
string[]
authOptions
any

[INTERNAL] Agent alias: an array of auth options, normalized server-side into the canonical single-auth top-level fields (one option) or the options record (multiple). Public callers use options directly; do not advertise this field.

type
enum<string>

Authentication protocol used by the connector.

Available options:
integration-app-token,
membrane-token,
oauth2,
oauth1,
client-credentials,
proxy
customCredentialsSchema
object

Additional JSON Schema for workspace-level overrides of credentials (e.g. BYO-OAuth clientId/clientSecret).

inputSchema
object

JSON Schema for end-user input collected during connection (e.g. an API key or subdomain the user types in).

parametersSchema
object
getCredentialsFromConnectionParameters
object

Function that derives auth credentials from connection parameters. Use for static-key auth (api-key, basic-auth) where the user-provided input IS the credential.

refreshCredentials
object

Function that refreshes expired credentials. Implement for non-standard OAuth refresh flows or when additional credentials need to be refreshed alongside the OAuth token.

makeApiClient
object

Function that configures the authenticated HTTP client used by connector API requests and actions. Typically a mapping type with baseUri and auth header wiring.

getOAuthConfig
object

OAuth2: function returning { authorizeUri, tokenUri, scopes, noRefreshToken? } — the authorize/token endpoint URLs and requested scopes.

getTokenData
object

OAuth2: function invoked with the raw token response to extract token metadata. Rarely needed.

getCredentialsFromAccessTokenResponse
object

OAuth2: function that transforms the token endpoint response into the final credentials object. Required for multi-tenant APIs (Microsoft) or APIs that require post-OAuth bootstrap calls.

getCredentialsFromRefreshTokenResponse
object

OAuth2: function that transforms the refresh token endpoint response into the refreshed credentials. Required when refresh responses differ from initial-token responses.

test
object

Function that verifies the connection by making a lightweight authenticated API call (typically a rest-api-mapping against a /me-style endpoint).

disconnect
object

Function that revokes credentials at the provider when the connection is removed. Implement only if the provider exposes a revoke endpoint.

proxyKey
string

For type: "proxy" — identifies which proxy configuration the workspace should use.

ui
object

[INTERNAL] Deprecated: Use inputSchema instead

options
object

Map of auth option key to auth configuration, for connectors that support multiple auth methods. Mutually exclusive with the top-level auth fields: use either the top-level fields (single-auth) OR options (multi-auth), not both.

uuid
string

Response

200 - application/json

Create a new connector. Pass the full connector spec as JSON. Returns the created connector including its ID.

id
string
key
string
name
string
isReadOnly
boolean
{key}
any