Jamdesk Documentation logo

邮件订阅

连接 Resend、Mailchimp、Kit、Loops、beehiiv、Brevo 或 SendGrid,将文档中的邮件订阅直接收集到您自己服务商的受众列表中。

Jamdesk 从您的文档站点收集电子邮件地址,并将其添加到您已经在用的邮件服务商。中间不经过任何第三方表单服务。在仪表板中连接一次服务商,然后即可在任意页面添加订阅表单。列表与发送均由您掌控。Jamdesk 负责采集地址并将其传递给您的服务商。

截图说明:屏幕截图显示的是英文界面。

前提条件

  • 拥有一个受支持服务商的账户
  • 来自该服务商、具有添加联系人权限的 API 密钥
  • 大多数服务商用于选择列表的受众标识符(Audience ID、List ID、Form ID 或 Publication ID)

捕获原理

Jamdesk 在保存 API 密钥之前,会先通过服务商的 API 对其进行验证。之后,文档站点上的每次表单提交都会调用服务商接口,将读者添加到您的受众列表中。提交会按访客和项目进行速率限制。隐藏的蜜罐字段可过滤机器人。

读者看到的表单如下所示:

标题为"获取 Jamdesk 发布说明"的订阅表单,包含"新功能和平台变更,直达您的收件箱"一行文字、一个邮箱字段和一个 Subscribe 按钮

Jamdesk 托管的订阅表单,即读者在已发布文档站点上看到的样子

您可以在 Jamdesk 更新日志上查看一个实际运行的示例。

您的 API 密钥存储在 Jamdesk 的后端,仅用于添加联系人。它永远不会写入您发布的站点、您的 docs.json 或任何客户端代码中。

支持的服务商

有七家服务商支持原生订阅采集。读者提交 Jamdesk 托管的表单,无需离开您的文档即可进入您的受众列表:

服务商需要连接的内容
ResendAPI 密钥(完全访问权限)+ Audience ID
MailchimpAPI 密钥(末尾为您的数据中心,例如 -us21)+ Audience(List)ID
Kit(ConvertKit)v4 API 密钥 + Form ID
LoopsAPI 密钥
beehiivAPI 密钥 + Publication ID
Brevov3 API 密钥 + Contact List ID
SendGrid具有 Marketing Contacts 写入权限的 API 密钥 + Marketing List ID

另外两家服务商仅支持嵌入。Jamdesk 渲染其自有的表单或 iframe,而不是采集地址。无需密钥:

服务商需要提供的内容
Buttondown您的账户 username(填写在 <EmailSubscribe> 标签上)
Substack您的账户 username(填写在 <EmailSubscribe> 标签上)

嵌入式服务商的设置方法请参阅 EmailSubscribe。

连接服务商

1
打开 Email Signups 卡片

在仪表板中打开您的项目,进入 Integrations。找到 Email Signups 卡片。

2
选择您的服务商

从 Provider 下拉菜单中选择服务商。表单随后会要求填写该服务商所需的字段,并提供获取 API 密钥的链接。

3
粘贴您的密钥和受众 ID

输入 API 密钥,并且对于大多数服务商,还需输入受众标识符(Loops 只需密钥)。密钥字段会被遮盖显示。

4
连接

点击 Connect。Jamdesk 在保存前会先通过您的服务商验证密钥。密钥错误或缺少联系人权限会显示错误,且不会保存任何内容。

连接成功的卡片会显示 Configured 徽章,以及您的服务商和受众 ID。此后发布的文档将渲染实时采集表单。

自定义表单文案

可选的 Form title 和 Form subtitle 字段用于设置自动放置表单的标题和副标题。留空时,表单仅显示邮箱字段和按钮。更新日志表单会在下次发布时采用已填写的字段,无需编辑 docs.json。

您可以随时修改此文案。编辑已连接卡片上的字段,然后点击 Save copy。您无需重新输入 API 密钥。在 docs.json 或 <EmailSubscribe> 标签上设置的 title 或 description 会覆盖仪表板中的文案。

将表单添加到文档

连接服务商本身不会放置表单。您需要选择订阅出现的位置:

  • 在任意页面中编写 <EmailSubscribe provider="resend" />(使用您已连接服务商的 id)。
  • 或在 docs.json 中设置 placement: changelog,以在每个更新日志页面自动放置表单。

EmailSubscribe 组件页面介绍了这些选项。

断开服务商连接

打开 Email Signups 卡片并点击 Remove,即可停止收集订阅。表单将在您下次发布时停止采集。

断开连接仅会从 Jamdesk 中移除密钥。您已收集的订阅者仍保留在您的服务商受众列表中,Jamdesk 不会删除他们。您可以随时重新连接。

下一步

EmailSubscribe 组件

放置订阅表单,并在更新日志页面自动挂载

Update 组件

编写读者订阅后将收到的更新日志条目