Connectors

Connect

Connect starts sign-in for Canvas. It sends the required permissions and the address that brings you back to Connections.

post/v1/connections/{name}/start

Request

Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
URL: /v1/connections/{name}/start
Auth: HTTP bearer

Path parameters

namestring required

Connection name.

Example:canvas

Request body

redirectTargetstring nullable

Backward-compatible camelCase alias for redirect_after.

redirect_afterstring nullable

Allowlisted desktop deep-link target.

requestedScopesstring[]

Backward-compatible camelCase alias for requested_scopes.

requested_scopesstring[]

Requested canonical scopes. Omit to request only required scopes.

Example request

{
  "redirectTarget": "https://oppulence.io/api/connectors/oauth/callback",
  "redirect_after": "solomon-ai://connection-complete",
  "requestedScopes": [
    "canvas:invoices.read"
  ],
  "requested_scopes": [
    "canvas:invoices.read"
  ]
}

Response

Connector authorize URL.

authorization_urlstring required

Browser URL the desktop opens to start the connector OAuth flow.

authorize_urlstring required

Backward-compatible alias for authorization_url.

expires_atstring required

Credential or one-time ticket expiry timestamp.

Example response

{
  "authorization_url": "https://oauth.solomon-ai.co/oauth2/auth?client_id=rowboat-api&state=...",
  "authorize_url": "https://oauth.solomon-ai.co/oauth2/auth?client_id=rowboat-api&state=...",
  "expires_at": "2026-06-04T20:48:00Z"
}

Changes

No recorded changes to this operation across all 50 revisions of this API.