pipedrive-automation
Compare original and translation side by side
🇺🇸
Original
English🇨🇳
Translation
ChinesePipedrive Automation via Rube MCP
通过Rube MCP实现Pipedrive自动化
Automate Pipedrive CRM workflows including deal management, contact and organization operations, activity scheduling, notes, and pipeline/stage queries through Composio's Pipedrive toolkit.
借助Composio的Pipedrive工具包,自动化Pipedrive CRM工作流,包括交易管理、联系人和组织操作、活动调度、笔记以及销售管道/阶段查询。
Prerequisites
前提条件
- Rube MCP must be connected (RUBE_SEARCH_TOOLS available)
- Active Pipedrive connection via with toolkit
RUBE_MANAGE_CONNECTIONSpipedrive - Always call first to get current tool schemas
RUBE_SEARCH_TOOLS
- 必须已连接Rube MCP(需具备RUBE_SEARCH_TOOLS功能)
- 通过并使用工具包
RUBE_MANAGE_CONNECTIONS激活Pipedrive连接pipedrive - 请始终先调用以获取最新的工具架构
RUBE_SEARCH_TOOLS
Setup
设置步骤
Get Rube MCP: Add as an MCP server in your client configuration. No API keys needed — just add the endpoint and it works.
https://rube.app/mcp- Verify Rube MCP is available by confirming responds
RUBE_SEARCH_TOOLS - Call with toolkit
RUBE_MANAGE_CONNECTIONSpipedrive - If connection is not ACTIVE, follow the returned auth link to complete Pipedrive OAuth
- Confirm connection status shows ACTIVE before running any workflows
获取Rube MCP:在客户端配置中添加作为MCP服务器。无需API密钥 —— 只需添加端点即可使用。
https://rube.app/mcp- 通过确认能正常响应,验证Rube MCP是否可用
RUBE_SEARCH_TOOLS - 调用并指定工具包
RUBE_MANAGE_CONNECTIONSpipedrive - 如果连接状态未显示为ACTIVE,请按照返回的授权链接完成Pipedrive OAuth认证
- 在运行任何工作流之前,确认连接状态显示为ACTIVE
Core Workflows
核心工作流
1. Create and Manage Deals
1. 创建与管理交易
When to use: User wants to create a new deal, update an existing deal, or review deal details in the sales pipeline.
Tool sequence:
- - Find existing org to link to the deal [Optional]
PIPEDRIVE_SEARCH_ORGANIZATIONS - - Create organization if none found [Optional]
PIPEDRIVE_ADD_AN_ORGANIZATION - - Find existing contact to link [Optional]
PIPEDRIVE_SEARCH_PERSONS - - Create contact if none found [Optional]
PIPEDRIVE_ADD_A_PERSON - - Resolve pipeline ID [Prerequisite]
PIPEDRIVE_GET_ALL_PIPELINES - - Resolve stage ID within the pipeline [Prerequisite]
PIPEDRIVE_GET_ALL_STAGES - - Create the deal with title, value, org_id, person_id, stage_id [Required]
PIPEDRIVE_ADD_A_DEAL - - Modify deal properties after creation [Optional]
PIPEDRIVE_UPDATE_A_DEAL - - Attach line items/products [Optional]
PIPEDRIVE_ADD_A_PRODUCT_TO_A_DEAL
Key parameters:
- : Deal title (required for creation)
title - : Monetary value of the deal
value - : 3-letter ISO currency code (e.g., "USD")
currency - /
pipeline_id: Numeric IDs for pipeline placementstage_id - /
org_id: Link to organization and contactperson_id - : "open", "won", or "lost"
status - : Format YYYY-MM-DD
expected_close_date
Pitfalls:
- is the only required field for
title; all others are optionalPIPEDRIVE_ADD_A_DEAL - Custom fields appear as long hash keys in responses; use dealFields endpoint to map them
- requires the numeric
PIPEDRIVE_UPDATE_A_DEALof the dealid - Setting to "lost" requires also providing
statuslost_reason
适用场景:用户需要创建新交易、更新现有交易,或查看销售管道中的交易详情。
工具执行顺序:
- - 查找可关联到交易的现有组织 [可选]
PIPEDRIVE_SEARCH_ORGANIZATIONS - - 若未找到匹配组织则创建新组织 [可选]
PIPEDRIVE_ADD_AN_ORGANIZATION - - 查找可关联的现有联系人 [可选]
PIPEDRIVE_SEARCH_PERSONS - - 若未找到匹配联系人则创建新联系人 [可选]
PIPEDRIVE_ADD_A_PERSON - - 获取销售管道ID [必备]
PIPEDRIVE_GET_ALL_PIPELINES - - 获取对应管道内的阶段ID [必备]
PIPEDRIVE_GET_ALL_STAGES - - 创建交易,需填写title、value、org_id、person_id、stage_id [必填]
PIPEDRIVE_ADD_A_DEAL - - 创建后修改交易属性 [可选]
PIPEDRIVE_UPDATE_A_DEAL - - 关联产品线/产品 [可选]
PIPEDRIVE_ADD_A_PRODUCT_TO_A_DEAL
关键参数:
- : 交易标题(创建交易时必填)
title - : 交易金额
value - : 3位ISO货币代码(例如:"USD")
currency - /
pipeline_id: 销售管道和阶段的数字IDstage_id - /
org_id: 关联的组织和联系人IDperson_id - : 交易状态,可选值为"open"(进行中)、"won"(已成交)或"lost"(已流失)
status - : 预计成交日期,格式为YYYY-MM-DD
expected_close_date
注意事项:
- 是
title唯一必填字段;其他参数均为可选PIPEDRIVE_ADD_A_DEAL - 自定义字段在响应中以长哈希键形式呈现;可通过dealFields端点映射这些字段
- 需要交易的数字
PIPEDRIVE_UPDATE_A_DEALid - 将设置为"lost"时,必须同时提供
status(流失原因)lost_reason
2. Manage Contacts (Persons and Organizations)
2. 管理联系人(个人与组织)
When to use: User wants to create, update, search, or list contacts and companies in Pipedrive.
Tool sequence:
- - Search for existing person by name, email, or phone [Prerequisite]
PIPEDRIVE_SEARCH_PERSONS - - Create new contact if not found [Required]
PIPEDRIVE_ADD_A_PERSON - - Modify existing contact details [Optional]
PIPEDRIVE_UPDATE_A_PERSON - - Retrieve full contact record [Optional]
PIPEDRIVE_GET_DETAILS_OF_A_PERSON - - Search for existing organization [Prerequisite]
PIPEDRIVE_SEARCH_ORGANIZATIONS - - Create new organization if not found [Required]
PIPEDRIVE_ADD_AN_ORGANIZATION - - Modify organization properties [Optional]
PIPEDRIVE_UPDATE_AN_ORGANIZATION - - Retrieve full org record [Optional]
PIPEDRIVE_GET_DETAILS_OF_AN_ORGANIZATION
Key parameters:
- : Required for both person and organization creation
name - : Array of objects with
email,value,labelfields for personsprimary - : Array of objects with
phone,value,labelfields for personsprimary - : Link a person to an organization
org_id - : 1 = owner only, 3 = entire company
visible_to - : Search term for SEARCH_PERSONS / SEARCH_ORGANIZATIONS (minimum 2 characters)
term
Pitfalls:
- may auto-merge with an existing org; check
PIPEDRIVE_ADD_AN_ORGANIZATIONresponse.additional_data.didMerge - Email and phone fields are arrays of objects, not plain strings:
[{"value": "test@example.com", "label": "work", "primary": true}] - wildcards like
PIPEDRIVE_SEARCH_PERSONSor*are NOT supported; use@to list allPIPEDRIVE_GET_ALL_PERSONS - Deletion via or
PIPEDRIVE_DELETE_A_PERSONis soft-delete with 30-day retention, then permanentPIPEDRIVE_DELETE_AN_ORGANIZATION
适用场景:用户需要在Pipedrive中创建、更新、搜索或列出联系人和公司信息。
工具执行顺序:
- - 通过姓名、邮箱或电话搜索现有联系人 [必备]
PIPEDRIVE_SEARCH_PERSONS - - 若未找到匹配联系人则创建新联系人 [必填]
PIPEDRIVE_ADD_A_PERSON - - 修改现有联系人详情 [可选]
PIPEDRIVE_UPDATE_A_PERSON - - 获取完整联系人记录 [可选]
PIPEDRIVE_GET_DETAILS_OF_A_PERSON - - 搜索现有组织 [必备]
PIPEDRIVE_SEARCH_ORGANIZATIONS - - 若未找到匹配组织则创建新组织 [必填]
PIPEDRIVE_ADD_AN_ORGANIZATION - - 修改组织属性 [可选]
PIPEDRIVE_UPDATE_AN_ORGANIZATION - - 获取完整组织记录 [可选]
PIPEDRIVE_GET_DETAILS_OF_AN_ORGANIZATION
关键参数:
- : 创建个人或组织时均为必填项
name - : 个人联系人的邮箱数组,每个元素为包含
email、value、label字段的对象primary - : 个人联系人的电话数组,每个元素为包含
phone、value、label字段的对象primary - : 将个人联系人关联到组织
org_id - : 可见范围,1 = 仅所有者可见,3 = 全公司可见
visible_to - :
term/SEARCH_PERSONS的搜索关键词(最少2个字符)SEARCH_ORGANIZATIONS
注意事项:
- 可能会自动合并现有组织;请检查
PIPEDRIVE_ADD_AN_ORGANIZATION字段response.additional_data.didMerge - 邮箱和电话字段为对象数组,而非纯字符串,格式示例:
[{"value": "test@example.com", "label": "work", "primary": true}] - 不支持
PIPEDRIVE_SEARCH_PERSONS或*等通配符;如需列出所有联系人,请使用@PIPEDRIVE_GET_ALL_PERSONS - 通过或
PIPEDRIVE_DELETE_A_PERSON执行的删除为软删除,保留30天后永久删除PIPEDRIVE_DELETE_AN_ORGANIZATION
3. Schedule and Track Activities
3. 安排与跟踪活动
When to use: User wants to create calls, meetings, tasks, or other activities linked to deals, contacts, or organizations.
Tool sequence:
- or
PIPEDRIVE_SEARCH_PERSONS- Resolve linked entity IDs [Prerequisite]PIPEDRIVE_GET_DETAILS_OF_A_DEAL - - Create the activity with subject, type, due date [Required]
PIPEDRIVE_ADD_AN_ACTIVITY - - Modify activity details or mark as done [Optional]
PIPEDRIVE_UPDATE_AN_ACTIVITY - - Retrieve activity record [Optional]
PIPEDRIVE_GET_DETAILS_OF_AN_ACTIVITY - - List user's activities [Optional]
PIPEDRIVE_GET_ALL_ACTIVITIES_ASSIGNED_TO_A_PARTICULAR_USER
Key parameters:
- : Activity title (required)
subject - : Activity type key string, e.g., "call", "meeting", "task", "email" (required)
type - : Format YYYY-MM-DD
due_date - : Format HH:MM
due_time - : Format HH:MM (e.g., "00:30" for 30 minutes)
duration - /
deal_id/person_id: Link to related entitiesorg_id - : 0 = not done, 1 = done
done
Pitfalls:
- Both and
subjectare required fortypePIPEDRIVE_ADD_AN_ACTIVITY - must match an existing ActivityTypes key_string in the account
type - is an integer (0 or 1), not a boolean
done - Response includes in additional_data
more_activities_scheduled_in_context
适用场景:用户需要创建与交易、联系人或组织关联的电话、会议、任务或其他活动。
工具执行顺序:
- 或
PIPEDRIVE_SEARCH_PERSONS- 获取关联实体的ID [必备]PIPEDRIVE_GET_DETAILS_OF_A_DEAL - - 创建活动,需填写subject、type、due date [必填]
PIPEDRIVE_ADD_AN_ACTIVITY - - 修改活动详情或标记为完成 [可选]
PIPEDRIVE_UPDATE_AN_ACTIVITY - - 获取活动记录 [可选]
PIPEDRIVE_GET_DETAILS_OF_AN_ACTIVITY - - 列出指定用户的所有活动 [可选]
PIPEDRIVE_GET_ALL_ACTIVITIES_ASSIGNED_TO_A_PARTICULAR_USER
关键参数:
- : 活动标题(必填)
subject - : 活动类型的键字符串,例如"call"(电话)、"meeting"(会议)、"task"(任务)、"email"(邮件)(必填)
type - : 截止日期,格式为YYYY-MM-DD
due_date - : 截止时间,格式为HH:MM
due_time - : 活动时长,格式为HH:MM(例如"00:30"表示30分钟)
duration - /
deal_id/person_id: 关联的实体IDorg_id - : 完成状态,0 = 未完成,1 = 已完成
done
注意事项:
- 和
subject是type的必填字段PIPEDRIVE_ADD_AN_ACTIVITY - 必须与账户中已有的ActivityTypes key_string匹配
type - 为整数(0或1),而非布尔值
done - 响应的additional_data字段中包含(关联的更多已安排活动)
more_activities_scheduled_in_context
4. Add and Manage Notes
4. 添加与管理笔记
When to use: User wants to attach notes to deals, persons, organizations, leads, or projects.
Tool sequence:
- or
PIPEDRIVE_SEARCH_PERSONS- Resolve entity ID [Prerequisite]PIPEDRIVE_GET_DETAILS_OF_A_DEAL - - Create note with HTML content linked to an entity [Required]
PIPEDRIVE_ADD_A_NOTE - - Modify note content [Optional]
PIPEDRIVE_UPDATE_A_NOTE - - List notes filtered by entity [Optional]
PIPEDRIVE_GET_ALL_NOTES - - Retrieve comments on a note [Optional]
PIPEDRIVE_GET_ALL_COMMENTS_FOR_A_NOTE
Key parameters:
- : Note body in HTML format (required)
content - /
deal_id/person_id/org_id/lead_id: At least one entity link requiredproject_id - /
pinned_to_deal_flag: Filter pinned notes when listingpinned_to_person_flag
Pitfalls:
- is required and supports HTML; plain text works but is sanitized server-side
content - At least one of ,
deal_id,person_id,org_id, orlead_idmust be providedproject_id - returns notes across all entities by default; filter with entity ID params
PIPEDRIVE_GET_ALL_NOTES
适用场景:用户需要为交易、个人、组织、线索或项目添加笔记。
工具执行顺序:
- 或
PIPEDRIVE_SEARCH_PERSONS- 获取实体ID [必备]PIPEDRIVE_GET_DETAILS_OF_A_DEAL - - 创建关联到实体的HTML格式笔记 [必填]
PIPEDRIVE_ADD_A_NOTE - - 修改笔记内容 [可选]
PIPEDRIVE_UPDATE_A_NOTE - - 按实体筛选列出笔记 [可选]
PIPEDRIVE_GET_ALL_NOTES - - 获取笔记的评论 [可选]
PIPEDRIVE_GET_ALL_COMMENTS_FOR_A_NOTE
关键参数:
- : HTML格式的笔记内容(必填)
content - /
deal_id/person_id/org_id/lead_id: 至少需要关联一个实体project_id - /
pinned_to_deal_flag: 列出笔记时筛选已固定的笔记pinned_to_person_flag
注意事项:
- 为必填项,支持HTML格式;纯文本也可使用,但会经过服务器端清理
content - 必须提供、
deal_id、person_id、org_id或lead_id中的至少一个project_id - 默认返回所有实体的笔记;可通过实体ID参数进行筛选
PIPEDRIVE_GET_ALL_NOTES
5. Query Pipelines and Stages
5. 查询销售管道与阶段
When to use: User wants to view sales pipelines, stages, or deals within a pipeline/stage.
Tool sequence:
- - List all pipelines and their IDs [Required]
PIPEDRIVE_GET_ALL_PIPELINES - - Get details and deal summary for a specific pipeline [Optional]
PIPEDRIVE_GET_ONE_PIPELINE - - List all stages, optionally filtered by pipeline [Required]
PIPEDRIVE_GET_ALL_STAGES - - Get details for a specific stage [Optional]
PIPEDRIVE_GET_ONE_STAGE - - List all deals across stages in a pipeline [Optional]
PIPEDRIVE_GET_DEALS_IN_A_PIPELINE - - List deals in a specific stage [Optional]
PIPEDRIVE_GET_DEALS_IN_A_STAGE
Key parameters:
- : Pipeline or stage ID (required for single-item endpoints)
id - : Filter stages by pipeline
pipeline_id - : 3-letter currency code or "default_currency" for converted totals
totals_convert_currency - : Set to 1 for deal summary in pipeline responses
get_summary
Pitfalls:
- takes no parameters; returns all pipelines
PIPEDRIVE_GET_ALL_PIPELINES - returns stages for ALL pipelines unless
PIPEDRIVE_GET_ALL_STAGESis specifiedpipeline_id - Deal counts in pipeline summaries use only when
per_stages_convertedis settotals_convert_currency
适用场景:用户需要查看销售管道、阶段,或管道/阶段内的交易。
工具执行顺序:
- - 列出所有销售管道及其ID [必填]
PIPEDRIVE_GET_ALL_PIPELINES - - 获取指定销售管道的详情与交易汇总 [可选]
PIPEDRIVE_GET_ONE_PIPELINE - - 列出所有阶段,可按管道筛选 [必填]
PIPEDRIVE_GET_ALL_STAGES - - 获取指定阶段的详情 [可选]
PIPEDRIVE_GET_ONE_STAGE - - 列出管道内所有阶段的交易 [可选]
PIPEDRIVE_GET_DEALS_IN_A_PIPELINE - - 列出指定阶段内的交易 [可选]
PIPEDRIVE_GET_DEALS_IN_A_STAGE
关键参数:
- : 销售管道或阶段的ID(单个项目端点必填)
id - : 按管道筛选阶段
pipeline_id - : 3位货币代码或"default_currency"(转换为默认货币),用于金额汇总转换
totals_convert_currency - : 设置为1时,在管道响应中返回交易汇总
get_summary
注意事项:
- 无需参数;返回所有销售管道
PIPEDRIVE_GET_ALL_PIPELINES - 除非指定,否则
pipeline_id会返回所有管道的阶段PIPEDRIVE_GET_ALL_STAGES - 仅当设置时,管道汇总中的交易数量才会使用
totals_convert_currency字段per_stages_converted
Common Patterns
通用模式
ID Resolution
ID解析
Always resolve display names to numeric IDs before operations:
- Organization name -> org_id: with
PIPEDRIVE_SEARCH_ORGANIZATIONSparamterm - Person name -> person_id: with
PIPEDRIVE_SEARCH_PERSONSparamterm - Pipeline name -> pipeline_id: then match by name
PIPEDRIVE_GET_ALL_PIPELINES - Stage name -> stage_id: with
PIPEDRIVE_GET_ALL_STAGESthen match by namepipeline_id
在执行操作前,请始终将显示名称转换为数字ID:
- 组织名称 -> org_id: 使用带参数的
termPIPEDRIVE_SEARCH_ORGANIZATIONS - 个人名称 -> person_id: 使用带参数的
termPIPEDRIVE_SEARCH_PERSONS - 管道名称 -> pipeline_id: 调用后按名称匹配
PIPEDRIVE_GET_ALL_PIPELINES - 阶段名称 -> stage_id: 调用带参数的
pipeline_id后按名称匹配PIPEDRIVE_GET_ALL_STAGES
Pagination
分页
Most list endpoints use offset-based pagination:
- Use (offset) and
start(page size) parameterslimit - Check to know if more pages exist
additional_data.pagination.more_items_in_collection - Use as the
additional_data.pagination.next_startvalue for the next pagestart - Default limit is ~500 for some endpoints; set explicitly for predictable paging
大多数列表端点使用基于偏移量的分页:
- 使用(偏移量)和
start(每页数量)参数limit - 检查字段判断是否还有更多数据
additional_data.pagination.more_items_in_collection - 使用作为下一页的
additional_data.pagination.next_start值start - 部分端点默认约为500;建议显式设置以确保分页可预测
limit
Known Pitfalls
已知注意事项
ID Formats
ID格式
- All entity IDs (deal, person, org, activity, pipeline, stage) are numeric integers
- Lead IDs are UUID strings, not integers
- Custom field keys are long alphanumeric hashes (e.g., "a1b2c3d4e5f6...")
- 所有实体ID(交易、个人、组织、活动、管道、阶段)均为数字整数
- 线索ID为UUID字符串,而非整数
- 自定义字段键为长字母数字哈希值(例如:"a1b2c3d4e5f6...")
Rate Limits
速率限制
- Pipedrive enforces per-company API rate limits; bulk operations should be paced
- and
PIPEDRIVE_GET_ALL_PERSONScan return large datasets; always paginatePIPEDRIVE_GET_ALL_ORGANIZATIONS
- Pipedrive对每个公司设置了API速率限制;批量操作需控制执行频率
- 和
PIPEDRIVE_GET_ALL_PERSONS可能返回大量数据;请始终使用分页PIPEDRIVE_GET_ALL_ORGANIZATIONS
Parameter Quirks
参数特殊情况
- Email and phone on persons are arrays of objects, not plain strings
- is numeric: 1 = owner only, 3 = entire company, 5 = specific groups
visible_to - on activities is integer 0/1, not boolean true/false
done - Organization creation may auto-merge duplicates silently; check in response
didMerge - requires minimum 2 characters and does not support wildcards
PIPEDRIVE_SEARCH_PERSONS
- 个人联系人的邮箱和电话为对象数组,而非纯字符串
- 为数字值:1 = 仅所有者可见,3 = 全公司可见,5 = 指定组可见
visible_to - 活动的字段为整数0/1,而非布尔值true/false
done - 创建组织时可能会自动静默合并重复项;请检查响应中的字段
didMerge - 要求关键词最少2个字符,且不支持通配符
PIPEDRIVE_SEARCH_PERSONS
Response Structure
响应结构
- Custom fields appear as hash keys in responses; map them via the respective Fields endpoints
- Responses often nest data under in wrapped executions
response.data.data - Search results are under , not top-level
response.data.items
- 自定义字段在响应中以哈希键形式呈现;可通过对应的Fields端点映射
- 在包装执行中,数据通常嵌套在下
response.data.data - 搜索结果位于下,而非顶层
response.data.items
Quick Reference
快速参考
| Task | Tool Slug | Key Params |
|---|---|---|
| Create deal | | |
| Update deal | | |
| Get deal details | | |
| Search persons | | |
| Add person | | |
| Update person | | |
| Get person details | | |
| List all persons | | |
| Search organizations | | |
| Add organization | | |
| Update organization | | |
| Get org details | | |
| Add activity | | |
| Update activity | | |
| Get activity details | | |
| List user activities | | |
| Add note | | |
| List notes | | |
| List pipelines | | (none) |
| Get pipeline details | | |
| List stages | | |
| Deals in pipeline | | |
| Deals in stage | | |
| Add product to deal | | |
| 任务 | 工具标识 | 关键参数 |
|---|---|---|
| 创建交易 | | |
| 更新交易 | | |
| 获取交易详情 | | |
| 搜索联系人 | | |
| 添加联系人 | | |
| 更新联系人 | | |
| 获取联系人详情 | | |
| 列出所有联系人 | | |
| 搜索组织 | | |
| 添加组织 | | |
| 更新组织 | | |
| 获取组织详情 | | |
| 添加活动 | | |
| 更新活动 | | |
| 获取活动详情 | | |
| 列出用户活动 | | |
| 添加笔记 | | |
| 列出笔记 | | |
| 列出销售管道 | | 无 |
| 获取管道详情 | | |
| 列出阶段 | | |
| 管道内交易 | | |
| 阶段内交易 | | |
| 为交易添加产品 | | |