--- title: Octapipe API Integration on Truto slug: octapipe category: CRM canonical: "https://truto.one/integrations/detail/octapipe/" --- # Octapipe API Integration on Truto **Category:** CRM **Status:** Generally available ## MCP-ready AI tools Truto exposes 42 tools for Octapipe that AI agents can call directly. - **get_single_octapipe_database_by_id** — Get a single Octapipe database by its UUID. Returns: uuid, name, description, icon, custom_fields, created_at, updated_at, and deleted_at. Required: id. - **list_all_octapipe_databases** — List all Octapipe databases with optional filtering, search, and ordering. Returns: uuid, name, description, icon, custom_fields, created_at, updated_at, and deleted_at for each database record. - **create_a_octapipe_database_record** — Create a new record in an octapipe database. Returns the created record including uuid, name, custom_fields_values, created_at, updated_at, database_uuid, owner_user, and creator_user. Required: database_uuid, name, custom_fields_values. - **get_single_octapipe_database_record_by_id** — Get a single octapipe database record by its uuid. Returns uuid, name, custom_fields_values, created_at, updated_at, deleted_at, database_uuid, owner_user, and creator_user. Required: database_uuid, id. - **list_all_octapipe_database_records** — List all records in an octapipe database with optional filtering, search, and sorting. Returns uuid, name, custom_fields_values, created_at, updated_at, database_uuid, owner_user, and creator_user per record. Required: database_uuid. Max 15 items per page. - **update_a_octapipe_database_record_by_id** — Update a database record in octapipe by its uuid. Returns the updated record including uuid, name, custom_fields_values, created_at, updated_at, database_uuid, owner_user, and creator_user. Required: database_uuid, id, name, custom_fields_values. - **octapipe_database_records_bulk_update** — Bulk update filtered database records in an octapipe database, applying new field values to every record that matches the given filters. Returns: success. Required: database_uuid, filters, values. - **delete_a_octapipe_database_record_by_id** — Delete a single octapipe database record by its uuid. Returns: success. Required: database_uuid, id. - **octapipe_database_records_bulk_delete** — Bulk delete filtered records from an octapipe database. Removes all records matching the given filters. Returns: success. Required: database_uuid, filters. - **octapipe_database_records_bulk_create** — Import multiple records into an octapipe database in bulk. Required: database_uuid. - **octapipe_database_records_bulk_export** — Export records from an octapipe database in bulk. Required: database_uuid. - **create_a_octapipe_file** — Upload a new file in Octapipe and associate it with an entity record. Returns the created file object including its uuid, url, name, mime, size, entity, created_at, and updated_at. Required: entity, record_uuid, file. - **list_all_octapipe_files** — List all files associated with an entity record in Octapipe. Returns: uuid, entity, name, url, mime, size, created_at, updated_at, deleted_at. Required: entity, record_uuid. - **delete_a_octapipe_file_by_id** — Delete an Octapipe file by its UUID. Returns: success. Required: id. - **create_a_octapipe_note** — Create a new note in Octapipe linked to a specific entity record. Returns: uuid, entity, note, created_at, updated_at, and the associated user object. Required: entity, record_uuid, note. - **list_all_octapipe_notes** — List all notes in Octapipe with optional filtering, search, and sorting. Returns per note: uuid, entity, note, created_at, updated_at, deleted_at, and the associated user object. - **delete_a_octapipe_note_by_id** — Delete a note in Octapipe by its UUID. Returns: success. Required: id. - **create_a_octapipe_notification** — Create a new notification in Octapipe linked to a specific entity record. Returns: uuid, entity, message, created_at, updated_at. Required: owner_user_uuid, entity, record_uuid, message. - **list_all_octapipe_notifications** — List all Octapipe notifications with support for filtering, searching, and ordering. Returns per record: uuid, entity, message, read_at, created_at, updated_at, deleted_at. - **get_single_octapipe_pipeline_by_id** — Get a single octapipe pipeline by its UUID. Returns: uuid, name, sum_custom_field_id, index, created_at, updated_at, deleted_at, and stages. Required: id. - **list_all_octapipe_pipelines** — List all octapipe pipelines. Returns: uuid, name, sum_custom_field_id, index, created_at, updated_at, deleted_at, and stages for each pipeline. Optionally filter with search, filters, orderBy, and direction. - **create_a_octapipe_pipeline_card** — Create a new pipeline card in octapipe. Returns: uuid, name, pipeline_uuid, pipeline_stage_uuid, created_at, updated_at, owner_user, creator_user, custom_fields_values. Required: pipeline_uuid, pipeline_stage_uuid, name, sla. - **get_single_octapipe_pipeline_card_by_id** — Get a single pipeline card by id in octapipe. Returns: uuid, name, tags, custom_fields_values, created_at, updated_at, deleted_at, pipeline_uuid, pipeline_stage_uuid, owner_user, creator_user. Required: pipeline_uuid, id. - **list_all_octapipe_pipeline_cards** — List all pipeline cards for a pipeline in octapipe, with optional filtering, searching, and sorting. Returns: uuid, name, tags, custom_fields_values, created_at, updated_at, deleted_at, pipeline_uuid, pipeline_stage_uuid, owner_user, creator_user. Required: pipeline_uuid. Max 15 items per page. - **update_a_octapipe_pipeline_card_by_id** — Update a pipeline card by id in octapipe. Returns: uuid, name, tags, custom_fields_values, created_at, updated_at, deleted_at, pipeline_uuid, pipeline_stage_uuid, owner_user, creator_user. Required: pipeline_uuid, id, pipeline_stage_uuid, name, sla. - **octapipe_pipeline_cards_bulk_update** — Bulk update all pipeline cards in octapipe that match the specified filters, applying the provided field values to each matched card. Returns: success. Required: pipeline_uuid, filters, values. - **delete_a_octapipe_pipeline_card_by_id** — Delete a single pipeline card by id in octapipe. Returns an empty 204 response on success. Required: pipeline_uuid, id. - **octapipe_pipeline_cards_bulk_delete** — Bulk delete pipeline cards in octapipe. Returns an empty 204 response on success. Required: pipeline_uuid. - **octapipe_pipeline_cards_bulk_create** — Bulk import pipeline cards into octapipe via the import endpoint. Returns an empty 204 response on success. Required: pipeline_uuid. - **octapipe_pipeline_cards_bulk_export** — Export pipeline cards from octapipe via the export endpoint. Returns an empty 204 response on success. Required: pipeline_uuid. - **get_single_octapipe_pipeline_stage_by_id** — Get a single octapipe pipeline stage by id. Returns: uuid, name, is_the_first_stage, is_the_final_stage, timeout, index, pipeline_uuid, created_at, updated_at, deleted_at. Required: pipeline_uuid, id. - **list_all_octapipe_pipeline_stages** — List all pipeline stages for a given pipeline in octapipe. Returns: uuid, name, is_the_first_stage, is_the_final_stage, timeout, index, pipeline_uuid, created_at, updated_at, deleted_at. Supports filtering, search, and sorting. Required: pipeline_uuid. - **create_a_octapipe_task** — Create a new task in octapipe. Returns: uuid, title, status, priority, start_date, end_date, start_time, end_time, created_at, updated_at. Required: title, start_date, end_date, start_time, end_time, status, priority. - **get_single_octapipe_task_by_id** — Get a single octapipe task by id. Returns: uuid, title, description, status, priority, start_date, end_date, start_time, end_time, created_at, updated_at, deleted_at. Required: id. - **list_all_octapipe_tasks** — List octapipe tasks with optional filtering, search, and sorting. Returns: uuid, title, description, status, priority, start_date, end_date, start_time, end_time, created_at, updated_at, deleted_at. Max 15 items per page. - **update_a_octapipe_task_by_id** — Update an existing octapipe task by id. Returns: uuid, title, description, status, priority, start_date, end_date, start_time, end_time, created_at, updated_at, deleted_at. Required: id, title, start_date, end_date, start_time, end_time, status, priority. - **octapipe_tasks_bulk_update** — Bulk update octapipe tasks matching the specified filters. Returns: success. Required: filters, values. - **delete_a_octapipe_task_by_id** — Delete a single octapipe task by id. Returns: success. Required: id. - **octapipe_tasks_bulk_delete** — Bulk delete octapipe tasks matching the specified filters. Returns: success. Required: filters. - **octapipe_tasks_bulk_create** — Import multiple octapipe tasks from an array of task objects. Required: an array where each item includes title, start_date, end_date, start_time, end_time, status, and priority. - **octapipe_tasks_bulk_export** — Export octapipe tasks. No request parameters or response details are documented in the available source. - **create_a_octapipe_authentication** — Authenticate an Octapipe user and receive a bearer token required for all subsequent API requests. Returns: token. Required: domain, email, password. ## How it works 1. **Link your customer's Octapipe 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 Octapipe.** The Proxy API is a 1-to-1 mapping of the Octapipe 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 - **Trigger operational workflows from your SaaS** — Let your customers automatically spawn Octapipe pipeline cards when key events happen in your product — form submissions, order cancellations, contract views — so their back-office teams pick up the work without manual handoff. - **Sync your system of record into Octapipe databases** — Keep Octapipe's custom databases continuously aligned with your ERP, inventory, or HR data using bulk create and update endpoints, so end users can reference up-to-date SKUs, employees, or accounts inside their workflows. - **Push enriched context onto existing records** — When a customer signs a document, uploads a file, or completes an action in your SaaS, attach the resulting file or note directly onto the relevant Octapipe pipeline card so operators see everything in one place. - **Drive SLA-bound task assignment** — Generate standardized task checklists with start times, end times, and priorities inside Octapipe whenever a new customer, hire, or order is created in your product — perfect for onboarding, fulfillment, and provisioning SaaS. - **Send actionable in-app notifications to Octapipe users** — Alert specific Octapipe users in real time about high-priority events from your platform, reducing response times without forcing them to switch tools or check email. ## What you can build - **Event-to-card automation** — Create new Octapipe pipeline cards in a chosen pipeline and stage whenever a defined event fires in your SaaS, with custom field values and SLA timers preset. - **Pipeline stage progression** — Programmatically move cards through pipeline stages as work progresses in your product, including advancing them into final stages when downstream conditions are met. - **Two-way database record sync** — Keep custom Octapipe databases in sync with your own entities using bulk create, update, delete, and export operations for nightly or near-real-time syncs. - **File and note attachment on cards** — Attach generated PDFs, contracts, or shipping labels and post structured notes onto the right Octapipe pipeline card directly from your SaaS workflows. - **Bulk task provisioning** — Spin up a standardized checklist of tasks with owners, priorities, and due dates in a single call — ideal for onboarding, IT provisioning, or fulfillment playbooks. - **Targeted in-app notifications** — Send notifications to specific Octapipe users tied to the records they own, surfacing time-sensitive updates from your platform inside their daily workspace. ## FAQs ### How do end users authenticate their Octapipe account? End users connect their Octapipe workspace through Truto's managed auth flow. Truto handles credential storage, refresh, and rotation so you don't store any Octapipe secrets yourself. ### Can we sync custom fields defined in a user's Octapipe workspace? Yes. Octapipe exposes custom field values on pipeline cards and database records (via custom_fields_values), and you can read and write them through the available create, update, and list endpoints. ### Does Truto support bulk operations for large data syncs? Yes. Octapipe offers bulk create, update, delete, and export endpoints for both database records and pipeline cards, plus bulk task operations — well-suited for nightly syncs from data warehouses or ERPs without hammering rate limits. ### Can we move a pipeline card to a specific stage programmatically? Yes. Use the update pipeline card endpoint to set the pipeline_stage_uuid, including advancing cards into stages where is_the_final_stage is true to close out workflows. ### Can we set SLAs on cards we create from our SaaS? Yes. The create pipeline card endpoint accepts an SLA parameter, so integrations can enforce operational timelines as soon as a card enters Octapipe. ### What kinds of objects can we read and write in Octapipe? The available tools cover pipelines, pipeline stages, pipeline cards, custom databases and their records, tasks, files, notes, and notifications — including single-record CRUD and bulk variants for cards, tasks, and database records. ## Related reading - [Connect Octapipe to ChatGPT: Manage Records, Files, and Data](https://truto.one/blog/connect-octapipe-to-chatgpt-manage-records-files-and-data/) — Learn how to connect Octapipe to ChatGPT using a managed MCP server. Automate pipelines, databases, and tasks with AI using secure, auto-generated tools. - [Connect Octapipe to Claude: Control Pipelines and Card Stages](https://truto.one/blog/connect-octapipe-to-claude-control-pipelines-and-card-stages/) — A complete engineering guide to connecting Octapipe to Claude using a managed MCP server. Learn how to securely automate pipelines, card stages, and databases. - [Connect Octapipe to AI Agents: Sync Tasks and Notifications](https://truto.one/blog/connect-octapipe-to-ai-agents-sync-tasks-and-notifications/) — Learn how to connect Octapipe to AI agents using Truto. Fetch auto-generated tools, bind them to frameworks like LangChain or LangGraph, and automate pipelines.