GEgetmembrane
Connections

Find or create a connection

Changed on
post/connections/ensure

Request

  • Base URL
    https://api.getmembrane.com
  • URL
    https://api.getmembrane.com/connections/ensure
  • Auth
    HTTP bearer

Request body

appUrlstring required

URL or domain of the app to connect to (e.g. "https://slack.com" or "slack.com"). Will be normalized to a domain.

namestring

Custom name for the connection. Only used when a new connection is created; ignored if an existing one is returned.

Response

idstring required

Internal database ID of the element. Assigned by the API; unique per element.

namestring required
userIdstring required
tenantIdstring
type'connector' | 'mcp'
keystring
isTestboolean
connectedboolean
disconnectedboolean

Use connected instead.

isDefunctboolean
state'BUILDING' | 'CLIENT_ACTION_REQUIRED' | 'CONFIGURATION_ERROR' | 'SETUP_FAILED' | 'READY' | 'DISCONNECTING'
integrationIdstring
connectorIdstring
externalAppIdstring
connectorVersionstring
authOptionKeystring
createdAtstring required
updatedAtstring required
lastActiveAtstring
nextCredentialsRefreshAtstring
nextRetryTimestampstring
retryAttemptsnumber
canTestboolean
canRefreshCredentialsboolean
archivedAtstring
isDeactivatedboolean
metaobject
buildingAgentSessionIdstring

Session ID for building the element via intent-based endpoints (create/update with intent). Present when state is BUILDING.

connectorParametersobject
inputobject

Changes