Connections

Start a connection

Mint a hosted OAuth link to connect an app; send the user to redirect_url. Some apps need setup first (see setup_fields). On return the connection appears in GET /connections.

post/connections/connect

Request

  • Base URL: https://api.crevio.co/v1
  • URL: https://api.crevio.co/v1/connections/connect
  • Auth: API key in header Authorization

Headers

Idempotency-Keystring

Makes this write safe to retry: a repeat with the same key replays the first response instead of creating a second resource. Scoped to the account, remembered for 24 hours; reusing a key with a different payload is an error.

Request body

toolkitstring required

App slug from the catalog (e.g. gmail)

callback_urlstring

Where to return the user after auth

scope'account' | 'user'

Who owns the resulting connection. account (default) shares it with the whole workspace; user makes it personal to the authenticated user and invisible to teammates.

Response

Success

object'connection_link' required
status'INITIATED' required
toolkitstring required
redirect_urlstring required

Hosted OAuth URL to send the user to

external_account_idstring
expires_atstring nullable

Changes

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