pipefy-members-email-webhooks

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Members, Email & Webhooks

成员、邮件与Webhooks

Manage pipe membership, send emails from card inboxes, read inbox replies, and manage webhooks. 12 MCP tools.

管理管道成员、从卡片收件箱发送邮件、读取收件箱回复以及管理Webhooks。12种MCP工具。

Member management

成员管理

Tool (MCP)	CLI	Read-only	Purpose
`invite_members`	`pipefy member invite`	No	Invite one or more users by email + role.
`add_service_account_to_pipe`	`pipefy member add-service-account`	No	Attach an existing org service account to a pipe by email + role (iPaaS setup). Verifies membership afterwards.
`remove_member_from_pipe`	`pipefy member remove`	No	Two-step destructive. Warns on external emails.
`set_role`	`pipefy member set-role`	No	Change a member's pipe role.

List existing members with

get_pipe_members

from skills/pipes-and-cards/pipefy-pipes-and-cards/SKILL.md.

工具（MCP）	CLI	只读	用途
`invite_members`	`pipefy member invite`	否	通过邮箱+角色邀请一位或多位用户。
`add_service_account_to_pipe`	`pipefy member add-service-account`	否	将现有组织service account通过邮箱+角色绑定到管道（iPaaS配置）。操作后会验证成员身份。
`remove_member_from_pipe`	`pipefy member remove`	否	两步式破坏性操作。针对外部邮箱会发出警告。
`set_role`	`pipefy member set-role`	否	修改成员的管道角色。

可通过skills/pipes-and-cards/pipefy-pipes-and-cards/SKILL.md中的

get_pipe_members

列出现有成员。

Steps — invite members

步骤 — 邀请成员

Check existing members:

MCP:

get_pipe_members pipe_id=67890

CLI:

pipefy member list --pipe 67890

Invite new members:
MCP:
```
invite_members pipe_id=67890 members='[{"email":"alice@example.com","role_name":"member"},{"email":"bob@example.com","role_name":"admin"}]'
```
CLI:
```
pipefy member invite --pipe 67890 --email alice@example.com --role member
```
Before inviting external emails (domain different from the org's known domains), warn the user that this is an external invitation and confirm before proceeding.

Before granting admin role, confirm with the user — admin is the highest pipe-level role.

检查现有成员：

MCP:

get_pipe_members pipe_id=67890

CLI:

pipefy member list --pipe 67890

邀请新成员：
MCP:
```
invite_members pipe_id=67890 members='[{"email":"alice@example.com","role_name":"member"},{"email":"bob@example.com","role_name":"admin"}]'
```
CLI:
```
pipefy member invite --pipe 67890 --email alice@example.com --role member
```
邀请外部邮箱（域名与组织已知域名不同）前，需提醒用户这是外部邀请，并在操作前确认。

授予admin角色前，需与用户确认——admin是管道级别最高的角色。

Steps — add a service account to a pipe (iPaaS setup)

步骤 — 将service account绑定到管道（iPaaS配置）

When setting up an iPaaS (Advanced Automations) flow that runs under a service account, the account must be a member of the target pipe, or pipe-scoped calls under its identity fail with a permission error even though the flow looks configured.

Get the service account's email. Either create one with
```
create_service_account(organization_uuid, name, role)
```
— which returns the account's email plus its OAuth2 client secret and token endpoint once (store them immediately) — or take the email from your organization's service-account settings. A freshly created account has no pipe access until this step. The pipe role defaults to
```
admin
```
(a service account running automations usually needs full pipe access); pass a narrower role only when you deliberately want to limit it.
One-step alternative:
```
create_service_account(organization_uuid, name, role, pipe_ids=[...])
```
provisions the account and adds it to the given pipes in one call, returning a
```
pipe_memberships
```
summary. Use it when you already know the target pipes.
Attach it (when not using the
```
pipe_ids
```
shortcut above):
MCP:
```
add_service_account_to_pipe pipe_id=67890 email=svc-automations@your-org.pipefy-service.com
```
(role defaults to
```
admin
```
)
CLI:
```
pipefy member add-service-account --pipe 67890 --email svc-automations@your-org.pipefy-service.com
```
The MCP tool verifies membership afterwards: it returns an error if the account is not a member of the pipe once the invite is processed, so an incomplete setup is not reported as success. The CLI does not verify — it prints the raw invite result, so check
```
inviteMembers.errors
```
(or run
```
pipefy member list --pipe <id>
```
) to confirm the account was actually added. This attaches an existing service account — create one first with
```
create_service_account
```
if you don't have one, and delete a throwaway with
```
delete_service_account(organization_uuid, service_account_uuid)
```
when done. See docs/mcp/tools/service-accounts.md.

当配置在service account下运行的iPaaS（高级自动化）流程时，该账户必须是目标管道的成员，否则即使流程配置完成，以该账户身份发起的管道范围调用仍会因权限错误失败。

获取service account的邮箱。可通过
```
create_service_account(organization_uuid, name, role)
```
创建一个（会一次性返回账户邮箱、OAuth2客户端密钥和令牌端点请立即存储），或从组织的service account设置中获取邮箱。新创建的账户在完成此步骤前无管道访问权限。管道角色默认是
```
admin
```
（运行自动化的service account通常需要完整的管道访问权限）；仅当刻意限制权限时，才传入更窄的角色。
一步式替代方案：
```
create_service_account(organization_uuid, name, role, pipe_ids=[...])
```
可在一次调用中创建账户并将其添加到指定管道，返回
```
pipe_memberships
```
摘要。当已明确目标管道时可使用此方法。
绑定账户（未使用上述
```
pipe_ids
```
快捷方式时）：
MCP:
```
add_service_account_to_pipe pipe_id=67890 email=svc-automations@your-org.pipefy-service.com
```
（角色默认是
```
admin
```
）
CLI:
```
pipefy member add-service-account --pipe 67890 --email svc-automations@your-org.pipefy-service.com
```
MCP工具操作后会验证成员身份：若邀请处理完成后账户仍未成为管道成员，会返回错误，不会将未完成的配置报告为成功。CLI不会进行验证——它会打印原始邀请结果，因此需检查
```
inviteMembers.errors
```
（或运行
```
pipefy member list --pipe <id>
```
）来确认账户是否已成功添加。此操作仅绑定现有service account——若没有则需先通过
```
create_service_account
```
创建，测试完成后可通过
```
delete_service_account(organization_uuid, service_account_uuid)
```
删除临时账户。详情见docs/mcp/tools/service-accounts.md。

Email (card inbox)

邮件（卡片收件箱）

Tool (MCP)	CLI	Read-only	Purpose
`get_card_inbox_emails`	`pipefy email inbox list --card <id>`	Yes	Read emails in a card's inbox.
`send_inbox_email`	`pipefy email inbox send`	No	Send an email from a card inbox.
`get_email_templates`	`pipefy email template list --repo <id>`	Yes	List org-level email templates.
`send_email_with_template`	`pipefy email template send`	No	Send using a template (substitutes variables).

工具（MCP）	CLI	只读	用途
`get_card_inbox_emails`	`pipefy email inbox list --card <id>`	是	读取卡片收件箱中的邮件。
`send_inbox_email`	`pipefy email inbox send`	否	从卡片收件箱发送邮件。
`get_email_templates`	`pipefy email template list --repo <id>`	是	列出组织级邮件模板。
`send_email_with_template`	`pipefy email template send`	否	使用模板发送邮件（替换变量）。

Steps — send a card inbox email

步骤 — 发送卡片收件箱邮件

Get the card's inbox emails (see what has been received):
MCP:
```
get_card_inbox_emails card_id=12345
```

Send a reply:

MCP:

send_inbox_email card_id=12345 to="customer@example.com" subject="Your request is in progress" body="Hi, we are processing your request."

CLI:

pipefy email inbox send --card 12345 --to customer@example.com --subject "Your request is in progress" --body "Hi, we are processing your request." --from-email you@example.com

获取卡片的收件箱邮件（查看已收到的邮件）：
MCP:
```
get_card_inbox_emails card_id=12345
```

发送回复：

MCP:

send_inbox_email card_id=12345 to="customer@example.com" subject="Your request is in progress" body="Hi, we are processing your request."

CLI:

pipefy email inbox send --card 12345 --to customer@example.com --subject "Your request is in progress" --body "Hi, we are processing your request." --from-email you@example.com

Webhooks

Tool (MCP)	CLI	Read-only	Purpose
`get_webhooks`	`pipefy webhook list --pipe <id>`	Yes	List all webhooks for a pipe.
`create_webhook`	`pipefy webhook create`	No	Register a new webhook endpoint.
`update_webhook`	`pipefy webhook update <id>`	No	Change URL, headers, or events.
`delete_webhook`	`pipefy webhook delete <id>`	No	Two-step destructive.

工具（MCP）	CLI	只读	用途
`get_webhooks`	`pipefy webhook list --pipe <id>`	是	列出管道的所有Webhooks。
`create_webhook`	`pipefy webhook create`	否	注册新的Webhook端点。
`update_webhook`	`pipefy webhook update <id>`	否	修改URL、请求头或事件。
`delete_webhook`	`pipefy webhook delete <id>`	否	两步式破坏性操作。

Steps — create a webhook

步骤 — 创建Webhook

List existing webhooks:

MCP:

get_webhooks pipe_id=67890

CLI:

pipefy webhook list --pipe 67890

Create the webhook:

MCP:

create_webhook pipe_id=67890 url="https://your-server.com/pipefy" actions='["card.create","card.done"]'

CLI:

pipefy webhook create --pipe 67890 --url https://your-server.com/pipefy --events card.create,card.done

列出现有Webhooks：

MCP:

get_webhooks pipe_id=67890

CLI:

pipefy webhook list --pipe 67890

创建Webhook：

MCP:

create_webhook pipe_id=67890 url="https://your-server.com/pipefy" actions='["card.create","card.done"]'

CLI:

pipefy webhook create --pipe 67890 --url https://your-server.com/pipefy --events card.create,card.done

Success criteria

成功标准

Invited members appear in
```
get_pipe_members
```
.
Sent emails show in the card's inbox thread.
Created webhooks receive test payloads from Pipefy on the configured events.

被邀请的成员出现在
```
get_pipe_members
```
的结果中。
已发送的邮件显示在卡片的收件箱对话中。
创建的Webhooks会在配置的事件触发时收到Pipefy的测试负载。

Failure modes

失败场景

invite_members
fails with "user not found": verify the email address is correct.
send_inbox_email
fails: the card must have an inbox enabled in the pipe settings.
Webhook never fires: verify the pipe events match the configured
```
actions
```
list; check that the endpoint URL is publicly reachable (not localhost).
delete_webhook
first call returns preview: expected — show preview, then call with
```
confirm=true
```
.

invite_members
失败并提示“user not found”：验证邮箱地址是否正确。
send_inbox_email
失败：管道设置中必须已启用卡片收件箱。
Webhook从未触发： 验证管道事件是否与配置的
```
actions
```
列表匹配；检查端点URL是否可公开访问（不能是localhost）。
delete_webhook
首次调用返回预览：此为预期行为——展示预览后，携带
```
confirm=true
```
参数再次调用即可。

另请参阅

```
skills/pipes-and-cards/
```
— create the pipe and cards before managing membership.
```
skills/observability/
```
— monitor email and webhook delivery logs.
skills/ipaas/pipefy-ipaas/SKILL.md — when a flow's service account needs pipe membership.

```
skills/pipes-and-cards/
```
— 在管理成员前先创建管道和卡片。
```
skills/observability/
```
— 监控邮件和Webhook的交付日志。
skills/ipaas/pipefy-ipaas/SKILL.md — 当流程的service account需要管道成员身份时参考。

pipefy-members-email-webhooks

Original

Translation

Members, Email & Webhooks

成员、邮件与Webhooks

Member management

成员管理

Steps — invite members

步骤 — 邀请成员

Steps — add a service account to a pipe (iPaaS setup)

步骤 — 将service account绑定到管道（iPaaS配置）

Email (card inbox)

邮件（卡片收件箱）

Steps — send a card inbox email

步骤 — 发送卡片收件箱邮件

Webhooks

Webhooks

Steps — create a webhook

步骤 — 创建Webhook

Success criteria

成功标准

Failure modes

失败场景

See also

另请参阅