Register OAuth Client

PUT/v1/integrations/oauth-clients/{provider}

Authorization

Authorizationstringrequired

Bearer token of an organization owner or admin. Format: `Bearer YOUR_API_KEY`

Path Parameters

providerenumrequired

The connector to configure

Possible values

google_drivegmailslack

Request Body

client_idstringrequired

The OAuth client ID from the customer's Google Cloud project or Slack app

Constraints

•Minimum length: 1•Maximum length: 256

client_secretstring(password)required

The OAuth client secret. Write-only: it is encrypted at rest and never returned.

signing_secretstring(password)

The app's signing secret, used to verify the webhooks it sends. Required for Slack; not accepted for Google connectors. Write-only.

return_urlstring

Required. Where the connector's OAuth callback returns the user after consent. Must be an absolute https URL (http is allowed for localhost). The outcome is appended as query parameters: provider, status, and installation_id or error.

Constraints

•Maximum length: 2048

Response Body

Request

cURL

PUT/v1/integrations/oauth-clients/{provider}

curl -X PUT https://api.mixedbread.com/v1/integrations/oauth-clients/gmail \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -d '{
    "client_id": "123456789012-abcdefghijklmnop.apps.googleusercontent.com",
    "client_secret": "GOCSPX-…",
    "return_url": "https://platform.example.com/connected"
  }'

Response

JSON

{
  "data": {
    "slot": {
      "provider": "gmail",
      "redirect_uri": "https://api.mixedbread.com/v1/integrations/gmail/oauth/callback",
      "required_scopes": [
        "https://www.googleapis.com/auth/gmail.readonly"
      ],
      "app_manifest": null,
      "client": {
        "provider": "gmail",
        "client_id": "123456789012-abcdefghijklmnop.apps.googleusercontent.com",
        "redirect_uri": "https://api.mixedbread.com/v1/integrations/gmail/oauth/callback",
        "return_url": "https://platform.example.com/connected",
        "has_signing_secret": false,
        "created_by_user_id": "da5f646d-4827-49a5-92cc-2f16a6594c27",
        "created_at": "2026-09-05T17:25:12.338038+00:00",
        "updated_at": "2026-09-05T17:25:12.338038+00:00"
      }
    },
    "reauth_required_installation_ids": [],
    "disconnected_installation_ids": []
  }
}