Connectors

Connect a connector

One call to connect anything. The answer is connected, authorization_required with a URL to open, or input_required with the fields to collect — branch on status; there is no fourth. Credentials are write-only and never come back.

post/v1/connectors/connections

Request

  • Base URL: https://api.spacefast.com
  • URL: https://api.spacefast.com/v1/connectors/connections
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://api.spacefast.com/v1/auth/oauth2/authorize, token URL https://api.spacefast.com/v1/auth/oauth2/token; client credentials, token URL https://api.spacefast.com/v1/auth/oauth2/token, scopes: connectors:write)

Query parameters

teamstring

Team id or slug to act for. Required only when the credential could act for more than one team.

Request body

connectorstring required

Connector slug to connect.

owner'team' | 'personal' required

Share it with the team, or keep it yours within this team.

displayNamestring

What to call it. Defaults to the connector's title.

descriptionstring

Agent-visible note on what this connection is for.

authMethodstring

Which of the connector's auth methods to use. Required only when more than one could apply.

returnPathstring

Dashboard path to land on after authorization. Same-origin only; absolute URLs are rejected.

Response

Response for status 200

$schemastring uri

Canonical JSON Schema URL for this response body. The server also sends it in the Link: rel="describedby" response header.

Changes

No recorded changes to this operation across all 1 revision of this API.