external_data_sources

Return a secure browser link for connecting a data warehouse source.

The link opens a minimal connect page rendering the source's full connection form — OAuth options included — with no table selection and no source creation. The user authenticates in their browser, secrets never pass through the agent, and the agent finishes setup afterwards by passing the stored credential id to data-warehouse-source-setup.

get/api/projects/{project_id}/external_data_sources/connect_link/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/external_data_sources/connect_link/
  • Auth: HTTP bearer

Path parameters

project_idstring required

Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Query parameters

source_typestring required

The source type to generate a connect link for (e.g. 'Stripe', 'Postgres', 'Hubspot').

Response

source_typestring required

The source type the link is for.

auth_method'oauth' | 'credentials' required
  • oauth - oauth
  • credentials - credentials
connect_urlstring required

Full URL to share with the user. It opens the source's connection form in PostHog — credentials never pass through the agent or the chat.

instructionsstring required

Next steps for the agent to relay to the user.

Changes

No recorded changes to this operation across all 1 revision of this API.