Skip to main content
POST
/
integrations
/
{kind}
/
connect
Error
A valid request URL is required to generate request examples
{
  "success": true,
  "data": {
    "oauthUrl": "<string>",
    "status": "connected"
  },
  "message": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

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
Available options:
google_calendar,
google_sheets,
calendly,
hubspot,
square,
opentable,
shopify,
postgres,
mysql

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.

credentials
object
Example:
{
"host": "db.example.com",
"port": "5432",
"database": "appdb",
"user": "flowyte_readonly",
"password": "<secret>",
"sslmode": "verify-full"
}

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. Never both.

message
string
errors
object[]