connections

Complete a connect flow from the forwarded provider callback.

POST

http://localhost:8000

/api/connectors/v1/connections/completions

Internal only — not available publicly or through the API gateway. The path carries no connection id because the callback names none: the connection is resolved from state, which this service minted at initiate and alone can resolve.

Complete a connect flow from the forwarded provider callback. › Request Body

The forwarded provider authorization response for a connect flow.

CompleteConnectRequest

state

string · required

The opaque connect state nonce that resolves the pending connection.

code

string

The provider authorization code, on a successful callback.

error

string

The provider error code, on an error callback (e.g. access_denied).

issueIdentifier

string

The issuer identifier from the authorization response, validated against the one recorded at initiate (RFC 9207).

Complete a connect flow from the forwarded provider callback. › Responses

The connected connection and the validated returnUrl to redirect to.

The connection resulting from a completed connect flow.

CompleteConnectResponse

connectionId

string · required

The connection's id.

redirectUrl

string · required

The fully-built URL to redirect the browser back to: the consumer's validated returnUrl carrying the new connection.

status

string · enum · required

The lifecycle state of a connection.

Enum values:

pending

connected

revoked

expired

List a consumer's connections.

GET

http://localhost:8000

/api/connectors/v1/{namespace}/{namespaceId}/connections

Returns the consumer's connections across every principal, each with its id, connector, principal and status. Not yet implemented — returns 501 until the behaviour lands.

List a consumer's connections. › path Parameters

namespace

string · enum · required

What the connection is based off of.

Enum values:

workspace

namespaceId

string · required

Identifier of the namespace instance the connection belongs to.

List a consumer's connections. › Responses

The consumer's connections.

The connections matching the request.

ListConnectionsResponse

Connection[] · required

The matching connections.

Begin a connect flow for a connector.

POST

http://localhost:8000

/api/connectors/v1/{namespace}/{namespaceId}/connections

Starts the authorization handshake for a connector, returning the provider authorize URL to redirect the browser to and the id minted for the connection. The connection itself is not written until the flow completes. Not yet implemented — returns 501 until the behaviour lands.

Begin a connect flow for a connector. › path Parameters

namespace

string · enum · required

What the connection is based off of.

Enum values:

workspace

namespaceId

string · required

Identifier of the namespace instance the connection belongs to.

Begin a connect flow for a connector. › Request Body

Request to begin a connect flow for a connector.

InitiateConnectRequest

connectorId

string · required

The connector to connect, from the catalogue.

returnUrl

string · pattern: (?i)https?://\S+ · required

Where the browser is returned after connecting; validated against the consumer's returnUrl origin allowlist.

connectionId

string · minLength: 0 · maxLength: 36 · pattern: \S+

An existing connection to reconnect in place. Omit to create a new connection.

scopes

string[]

The scopes to request; must be a subset of the connector's declared scopes. Omit to request the connector's declared scopes. An empty array means the same as omitting it — there is no way to request no scopes at all.

Begin a connect flow for a connector. › Responses

The authorize URL and the new pending connection id.

The authorize URL and the connection id for this flow.

InitiateConnectResponse

authorizeUrl

string · required

The fully-built provider authorization URL to redirect the browser to.

connectionId

string · required

The connection id; the sole handle for later token resolution.

Revoke a credential and disconnect a connection.

DELETE

http://localhost:8000

/api/connectors/v1/{namespace}/{namespaceId}/connections/{connectionId}

Revokes the stored credential and disconnects the connection, stopping every caller at once. The connection ends in the revoked status rather than being deleted. Not yet implemented — returns 501 until the behaviour lands.

Revoke a credential and disconnect a connection. › path Parameters

namespace

string · enum · required

What the connection is based off of.

Enum values:

workspace

namespaceId

string · required

Identifier of the namespace instance the connection belongs to.

connectionId

string · required

The connection to revoke.

Revoke a credential and disconnect a connection. › Responses

Revoked.

No data returned

Make a bodyless call through a connection to the third party.

GET

http://localhost:8000

/api/connectors/v1/{namespace}/{namespaceId}/connections/{connectionId}/call/{upstreamPath}

Forwards the request to the connector's upstream with the stored credential injected, and returns the third party's response as it arrived. The path after /call/ is the upstream's own path, and any query string on it is forwarded with it. A failure this service generates carries the Sqsp-Connector-Error header. Served for custom OAuth connectors.

Make a bodyless call through a connection to the third party. › path Parameters

namespace

string · enum · required

What the connection is based off of.

Enum values:

workspace

namespaceId

string · required

Identifier of the namespace instance the connection belongs to.

connectionId

string · required

The connection to call through.

upstreamPath

string · required

The third party's own path, forwarded as given. Spans every segment after /call/, slashes included.

Make a bodyless call through a connection to the third party. › Responses

The upstream response, passed through. Any status the upstream returns.

string

Make a call carrying a body through a connection to the third party.

PUT

http://localhost:8000

/api/connectors/v1/{namespace}/{namespaceId}/connections/{connectionId}/call/{upstreamPath}

Forwards the request and its body to the connector's upstream with the stored credential injected, and returns the third party's response as it arrived. The body is passed through unread. A failure this service generates carries the Sqsp-Connector-Error header. Served for custom OAuth connectors.

Make a call carrying a body through a connection to the third party. › path Parameters

namespace

string · enum · required

What the connection is based off of.

Enum values:

workspace

namespaceId

string · required

Identifier of the namespace instance the connection belongs to.

connectionId

string · required

The connection to call through.

upstreamPath

string · required

The third party's own path, forwarded as given. Spans every segment after /call/, slashes included.

Make a call carrying a body through a connection to the third party. › Request Body

string

Make a call carrying a body through a connection to the third party. › Responses

The upstream response, passed through. Any status the upstream returns.

string

Make a call carrying a body through a connection to the third party.

POST

http://localhost:8000

/api/connectors/v1/{namespace}/{namespaceId}/connections/{connectionId}/call/{upstreamPath}

Make a call carrying a body through a connection to the third party. › path Parameters

namespace

string · enum · required

What the connection is based off of.

Enum values:

workspace

namespaceId

string · required

Identifier of the namespace instance the connection belongs to.

connectionId

string · required

The connection to call through.

upstreamPath

string · required

The third party's own path, forwarded as given. Spans every segment after /call/, slashes included.

Make a call carrying a body through a connection to the third party. › Request Body

string

Make a call carrying a body through a connection to the third party. › Responses

The upstream response, passed through. Any status the upstream returns.

string

Make a bodyless call through a connection to the third party.

DELETE

http://localhost:8000

/api/connectors/v1/{namespace}/{namespaceId}/connections/{connectionId}/call/{upstreamPath}

Make a bodyless call through a connection to the third party. › path Parameters

namespace

string · enum · required

What the connection is based off of.

Enum values:

workspace

namespaceId

string · required

Identifier of the namespace instance the connection belongs to.

connectionId

string · required

The connection to call through.

upstreamPath

string · required

The third party's own path, forwarded as given. Spans every segment after /call/, slashes included.

Make a bodyless call through a connection to the third party. › Responses

The upstream response, passed through. Any status the upstream returns.

string

Make a call carrying a body through a connection to the third party.

PATCH

http://localhost:8000

/api/connectors/v1/{namespace}/{namespaceId}/connections/{connectionId}/call/{upstreamPath}

Make a call carrying a body through a connection to the third party. › path Parameters

namespace

string · enum · required

What the connection is based off of.

Enum values:

workspace

namespaceId

string · required

Identifier of the namespace instance the connection belongs to.

connectionId

string · required

The connection to call through.

upstreamPath

string · required

The third party's own path, forwarded as given. Spans every segment after /call/, slashes included.

Make a call carrying a body through a connection to the third party. › Request Body

string

Make a call carrying a body through a connection to the third party. › Responses

The upstream response, passed through. Any status the upstream returns.

string

grants