RHrhythms
connections

Connect or reconnect using a personal access token

Changed on

Validates connector-specific PAT fields and creates the current user's connection. When reconnect is true, replaces an existing healthy personal connection's credentials only after validation, preserving its UUID and existing credentials if validation fails. Requests without reconnect remain idempotent.

post/connections/connect_via_pat

Request

  • Base URL
    https://api.rhythms.ai
  • URL
    https://api.rhythms.ai/connections/connect_via_pat
  • Auth
    none required

Request body

app_typestring required

PAT-capable connector connection type.

connector_uuidstring

Connector UUID; required when multiple connectors have the same type.

pat_fieldsobject

Credential values keyed by the connector's pat_required_fields names.

reconnectboolean

Replace credentials on the current user's existing healthy personal connection.

entry_pointstring

Surface initiating connector setup.

Changes