Sign in
Connectors

Start connector connection flow

Changed on

Starts the provider OAuth flow using a cryptographically random single-use state bound to this Monet install.

post/api/connectors/{connectorId}/connect

Request

  • The document declares no server URL.
  • Auth: none declared

Path parameters

connectorIdstring required
Example:github

Request body

redirectUrlstring uri

Example request

{
  "redirectUrl": "monet://connectors/callback"
}

Response

Connector connection flow started successfully.

status'redirect_required' | 'connected' | 'pending' required
connectorId'github' | 'notion' | 'google_drive' required
providerConnectionIdstring
redirectUrlstring uri
expiresAtstring date-time

Example response

{
  "status": "redirect_required",
  "connectorId": "github",
  "providerConnectionId": "conn_123",
  "redirectUrl": "https://accounts.provider.example/oauth/authorize?...",
  "expiresAt": "2026-04-27T10:05:00.000Z"
}

Changes