--- title: FlowMate API Integration on Truto slug: flowmate category: Application Development canonical: "https://truto.one/integrations/detail/flowmate/" --- # FlowMate API Integration on Truto **Category:** Application Development **Status:** Generally available ## MCP-ready AI tools Truto exposes 20 tools for FlowMate that AI agents can call directly. - **create_a_flow_mate_auth** — Log in to FlowMate with username and password. Returns the authentication token and its id. Required: username, password. - **list_all_flow_mate_flow** — List flows in flowmate. Returns the flow records including id, name, type, status, createdAt, and updatedAt. - **get_single_flow_mate_flow_by_id** — Get a single flowmate flow by id. Returns data containing the full flow record, plus meta. Required: id. - **delete_a_flow_mate_flow_by_id** — Delete a flowmate flow by id. Returns an empty success object on success. Required: id. - **update_a_flow_mate_flow_by_id** — Update an existing flowmate flow by id. Returns data containing the updated flow record, plus meta. Required: id, name, graph, type. - **flow_mate_flow_start** — Start a flowmate flow by flow_id. Returns data with the flow id and new status, plus meta. Required: flow_id. - **flow_mate_flow_stop** — Stop a flowmate flow's integration process by flow id. Returns the flow's id and new status under data, plus response metadata. Required: flow_id. - **list_all_flow_mate_flow_template** — List flow templates in flowmate available to the current user or their tenants. Returns: type, id, status, createdAt, updatedAt. Supports filtering by status, user, sort, search, and tags. - **create_a_flow_mate_flow_template** — Create a new flow template in flowmate. Returns data (the created template object, including id, name, type, status, createdAt, and updatedAt) and meta. Required: name, graph, type. - **get_single_flow_mate_flow_template_by_id** — Get a single flow template in flowmate by id. Returns data (the template with id, name, status, createdAt, updatedAt) and meta. Required: id. - **delete_a_flow_mate_flow_template_by_id** — Delete a flow template in flowmate by id. Returns an empty 204 response on success. Required: id. - **update_a_flow_mate_flow_template_by_id** — Update an existing flow template in flowmate by id. Returns data (the updated template with id, name, status, createdAt, updatedAt) and meta. Required: id. - **flow_mate_flow_template_generate_flow_from_template** — Generate a new flow in flowmate from an existing flow template. Returns data and meta, where data contains the new flow's id and status. Required: template_id. Deprecated. - **list_all_flow_mate_user** — List all users in flowmate. Returns user records including id, username, firstname, lastname, status, tenant, roles, permissions, confirmed, and img. Optional: meta. - **create_a_flow_mate_user** — Create a new user in flowmate. Returns the created user with id, username, firstname, lastname, status, tenant, roles, permissions, confirmed, and img. Required: username, firstname, lastname. - **get_single_flow_mate_user_by_id** — Get a single flowmate user by id. Returns: id, username, password. Required: id. - **flow_mate_user_get_current** — Get the current authenticated flowmate user. Returns: id, username, password. - **list_all_flow_mate_reporting** — List execution counts for FlowMate reporting by time frame. Returns grouped execution records in data (_id, user, tenant, allFlows, executions, username) and period metadata with start, end, and totalExecutions. Optional: start, end, groupby. - **list_all_flow_mate_log** — List flowmate logs for a tenant, optionally filtered by flow, step, or error-only mode. Returns the raw response object. Required: tenant. - **create_a_flow_mate_webhook** — Send a JSON payload to a FlowMate incoming webhook by webhook_id (flow ID). The body is processed in the flow. Returns an empty JSON object on success. Required: webhook_id. ## How it works 1. **Link your customer's FlowMate account.** Use Truto's frontend SDK; we handle every OAuth and API key flow so you don't need to create the OAuth app. 2. **Authentication is automatic.** Truto refreshes tokens, stores credentials securely, and injects them into every API request. 3. **Call Truto's API to reach FlowMate.** The Proxy API is a 1-to-1 mapping of the FlowMate API. 4. **Get a unified response format.** Every response uses a single shape, with cursor-based pagination and data in the `result` field. ## Use cases - **Embed a white-labeled integration marketplace** — Offer your customers a native catalog of automations powered by FlowMate flows, without exposing that FlowMate runs underneath. Provision tenants, spin up flows from templates, and toggle them on per customer through Truto. - **Ship AI agent execution with tenant isolation** — Let your AI product safely execute actions across your customers' connected SaaS tools by routing intents into FlowMate flows via webhooks. Truto handles auth and API mechanics so your agent stays focused on reasoning, not credential storage. - **Automate customer onboarding with templated flows** — Generate a customized flow from a master template every time a new customer signs up, then start it programmatically. This makes integrations feel native to your product instead of a separate iPaaS setup. - **Build native integration health dashboards** — Surface flow logs and errors inside your own UI so customers can self-diagnose failed syncs. Deflect support tickets by exposing per-tenant error logs without ever mentioning FlowMate. - **Power usage-based billing and tier enforcement** — Pull FlowMate reporting data to meter how many automations each customer consumes. Use it to enforce plan limits, trigger upgrade prompts, or bill by execution volume. ## What you can build - **One-click flow activation toggle** — A UI switch in your app that calls flow_start or flow_stop to activate or pause an integration for a specific customer. - **Template-driven integration provisioning** — Maintain reusable flow templates and generate per-tenant flows on demand when a customer enables an integration. - **Event-to-flow webhook bridge** — Forward internal product events (deal won, invoice paid, user created) to a FlowMate webhook that fans out into customer-configured downstream actions. - **Per-tenant integration health tab** — An embedded dashboard that pulls FlowMate logs filtered by tenant and error state so customers can debug their own integrations. - **Usage metering for automation plans** — A billing view that queries FlowMate reporting to display execution counts and enforce workflow quotas per customer tier. - **AI agent action layer** — A secure execution path where your AI assistant sends structured JSON intents to a customer's flow, letting FlowMate perform the third-party API calls under the correct tenant credentials. ## FAQs ### How is authentication to FlowMate handled? Truto manages FlowMate auth for you through the create_a_flow_mate_auth flow. Your end users connect once and Truto securely stores and refreshes credentials, so your app never touches FlowMate API keys directly. ### Can I provision a separate FlowMate tenant per customer? Yes. Use create_a_flow_mate_user to spin up an isolated user record when a new customer signs up, which houses their connected app credentials and execution boundaries. ### How do I trigger a flow from my product's events? Use create_a_flow_mate_webhook to register a webhook against a specific flow, then POST your event payloads to it. FlowMate routes the payload into the flow's graph and executes the downstream actions. ### Can I generate integrations from templates instead of building each flow manually? Yes. Maintain templates via the flow template endpoints and call flow_mate_flow_template_generate_flow_from_template to produce a customer-specific flow instance whenever it's needed. ### What observability data can I surface to my end users? list_all_flow_mate_log returns execution logs that can be filtered by tenant and error state, and list_all_flow_mate_reporting exposes execution volumes. Both are typically embedded into a native integration health or usage view. ### Can I start and stop integrations programmatically? Yes. flow_mate_flow_start and flow_mate_flow_stop let you activate or pause a flow on demand, which is how most customers wire up an 'Enable Integration' toggle in their product UI. ## Related reading - [Connect FlowMate to ChatGPT: Manage and Automate Workflow Lifecycles](https://truto.one/blog/connect-flowmate-to-chatgpt-manage-and-automate-workflow-lifecycles/) — Learn how to connect FlowMate to ChatGPT using a managed MCP server. Automate workflow lifecycles, monitor logs, and trigger FlowMate webhooks with AI. - [Connect FlowMate to Claude: Orchestrate Templates and User Access](https://truto.one/blog/connect-flowmate-to-claude-orchestrate-templates-and-user-access/) — Learn how to connect FlowMate to Claude using a managed MCP server. This technical guide covers orchestration workflows, template management, and API access control. - [Connect FlowMate to ChatGPT: Manage and monitor automation flows](https://truto.one/blog/connect-flowmate-to-chatgpt-manage-and-monitor-automation-flows/) — Learn how to connect FlowMate to ChatGPT using a managed MCP server. Automate workflow debugging, manage complex execution graphs, and query tenant-scoped logs without writing API boilerplate. - [Connect FlowMate to AI Agents: Monitor Logs and Trigger Flow Actions](https://truto.one/blog/connect-flowmate-to-ai-agents-monitor-logs-and-trigger-flow-actions/) — A technical guide to connecting FlowMate to AI Agents. Learn how to map FlowMate API endpoints to LLM tools, manage execution logs, and orchestrate automated workflows. - [Connect FlowMate to AI Agents: Run flows and analyze system logs](https://truto.one/blog/connect-flowmate-to-ai-agents-run-flows-and-analyze-system-logs/) — Learn how to connect FlowMate to AI agents to independently run automations, manage flow execution, and analyze system logs using Truto's /tools endpoint.