Be the first to get access to new connectors. Get early access →
ConnectorBay Early access

Userpilot (BYOK) — connector documentation

  • MCP endpoint: https://byok-userpilot.connectorbay.com/mcp
  • REST API: POST https://byok-userpilot.connectorbay.com/v1/tools/{tool_name}, described by the OpenAPI 3.1 spec at https://byok-userpilot.connectorbay.com/openapi.json
  • Transport: Streamable HTTP, stateless, MCP specification 2025-06-18 or later
  • Authentication: your own Userpilot Userpilot API key, sent in the X-Upstream-Key header of every request (never stored, logged or cached)
  • Health: https://byok-userpilot.connectorbay.com/health · Tool schemas: https://byok-userpilot.connectorbay.com/tools.json
  • Publisher: Unify Dynamics LLC · connectorbay.com/byok-userpilot · agent@connectorbay.com

What Userpilot (BYOK) is for

Userpilot (BYOK) lets an AI assistant read your own Userpilot data through the Userpilot API with a key you supply (Userpilot API key). Read-only: 11 tools (list_segments, list_flows, list_banners, list_embeds, list_spotlights, list_surveys, list_checklists, list_resource_center_modules, list_tracked_features_and_events, list_user_properties, list_company_properties). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it is only ever sent to appex.userpilot.io. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Userpilot. Userpilot and its logos are trademarks of their owners and are used only to say which service the connector works with.

Ask your assistant things like:

  • "Which user segments exist in my Userpilot account?"
  • "Which flows exist in Userpilot?"
  • "Which banners exist in Userpilot?"
  • "Which embeds and cards does Userpilot have?"
  • "Which spotlights exist in Userpilot?"
  • "Which surveys are set up in Userpilot and what do they ask?"

What it does

  • list_segments: List user segments with id, title, usage, category, status and whether they are hidden or protected.
  • list_flows: List the in-app flows (experiences) with their ids and titles. Uses the standard Userpilot application host (appex.userpilot.io); EU or dedicated environments with another host are not supported.
  • list_banners: List the in-app banners with their ids and titles. Uses the standard Userpilot application host (appex.userpilot.io); EU or dedicated environments with another host are not supported.
  • list_embeds: List embedded content (banners and cards) with id, title and type. Uses the standard Userpilot application host (appex.userpilot.io); EU or dedicated environments with another host are not supported.
  • list_spotlights: List the spotlights (feature highlights) with their ids and titles. Uses the standard Userpilot application host (appex.userpilot.io); EU or dedicated environments with another host are not supported.
  • list_surveys: List the surveys with id, title, platform and their question modules. Uses the standard Userpilot application host (appex.userpilot.io); EU or dedicated environments with another host are not supported.
  • list_checklists: List the checklists (with their tasks) by key and display name. Uses the standard Userpilot application host (appex.userpilot.io); EU or dedicated environments with another host are not supported.
  • list_resource_center_modules: List the resource center modules by key and display name. Uses the standard Userpilot application host (appex.userpilot.io); EU or dedicated environments with another host are not supported.
  • list_tracked_features_and_events: List the tracked features and events by key and display name. Uses the standard Userpilot application host (appex.userpilot.io); EU or dedicated environments with another host are not supported.
  • list_user_properties: List the user properties Userpilot holds, with key, display name, data type and whether they are automatic. Uses the standard Userpilot application host (appex.userpilot.io); EU or dedicated environments with another host are not supported.
  • list_company_properties: List the company properties Userpilot holds, with key, display name, data type and whether they are automatic. Uses the standard Userpilot application host (appex.userpilot.io); EU or dedicated environments with another host are not supported.

BYOK key

You bring your own Userpilot Userpilot API key (https://run.userpilot.io/environment). Your assistant sends it in the X-Upstream-Key header with each request. ConnectorBay uses it for that one call only: it is never stored, logged or cached, never shown in an answer, and it is only sent to appex.userpilot.io over https, with no redirects followed. Create a key with the fewest permissions the tools need (read-only if the provider offers it), and revoke it at the provider whenever you like.

Data sources

Live from the Userpilot API (appex.userpilot.io) with a BYOK key; documentation: https://docs.userpilot.com/api-reference/introduction. Endpoints checked against that documentation on 2026-10-16.

What it is not

Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Userpilot. Userpilot and its logos are trademarks of their owners and are used only to say which service the connector works with. It is read-only: it never creates, changes, sends or deletes anything in your Userpilot account.

Built for: Worldwide. Languages: English.