Skip to main content
POST

Authorizations

Authorization
string
header
required

Flowyte secret API key (Authorization: Bearer flowyte_sk_live_…). Scope-gated; is scoped to your organization — a key can never reach another tenant. The listed scopes in each operation's apiKey requirement are the scopes that key must hold. The tokenUrl is nominal: keys are minted in the dashboard.

Path Parameters

kind
enum<string>
required

The integration provider (connector). One of the supported connector slugs: native providers (google_calendar, google_sheets, calendly, hubspot, ``, square, opentable, shopify), SQL databases (postgres, mysql), the universal Zapier MCP fallback (zapier), or Composio (composio).

Available options:
google_calendar,
google_sheets,
calendly,
hubspot,
square,
opentable,
shopify,
postgres,
mysql,
zapier,
composio

Body

application/json

Optional connect body. For an api_key provider supply credentials (ignored for oauth2). The required credential KEYS depend on the provider kind: • Most api_key providers: { "apiKey": "..." }. • SQL databases (postgres, mysql): a structured connection descriptor — host (required), port (required, string), database (required), user (required), password (required), sslmode (required; one of require | verify-ca | verify-full — disable is refused at the connect boundary), and ca_pem (optional PEM for verify-ca/ verify-full). Prefer a least-privilege read-only role (see GET /integrations/{kind}/sql/scripts), and validate first with POST /integrations/{kind}/sql/test. • Composio (kind=composio): supply { "toolkit_slug": "gmail" } (NOT credentials) — the connect creates/reuses a Composio auth config, mints a Connect Link, and returns { "redirectUrl": "..." } to open in the browser. No credential is ever sent to Flowyte.

credentials
object
Example:
toolkit_slug
string

Composio only: the Composio toolkit to link (e.g. gmail, hubspot).

Example:

"gmail"

Response

OAuth redirect URL (oauth2) or connected status (api_key).

success
boolean
required
data
object
required

oauthUrl for an oauth2 connect; status for an api_key connect; redirectUrl for a Composio Connect-Link connect. Never more than one.

message
string
errors
object[]