Echobell

App Store Connect Webhook 集成

学习如何将 App Store Connect Webhook 与 Echobell 集成,获取即时应用状态通知和 TestFlight 反馈提醒

App Store Connect Webhook 集成

App Store Connect 提供 Webhook 功能,可以直接向您的服务器发送关于应用状态变化和 TestFlight 反馈的实时通知。通过将 App Store Connect Webhook 与 Echobell 集成,您可以在 iOS 应用发生重要事件时立即在移动设备上接收通知。

App Store Connect Webhook 适用于具有 Account Holder、Admin 或 App Manager 角色的开发者。每个 Webhook 只能应用于一个应用,每个应用最多可以创建十个 Webhook。

先决条件

  • 至少创建了一个频道的 Echobell 账户
  • 具有 Account Holder、Admin 或 App Manager 角色的 App Store Connect 访问权限
  • App Store Connect 中的活跃 iOS 应用
  • 您的 Echobell Webhook URL(在频道设置中可用)

可监控的内容

App Store Connect Webhook 可以通知您以下事件:

  1. 应用版本状态变化

    • 应用提交状态更新
    • 应用审核批准或拒绝
    • 应用在 App Store 发布
    • 版本更新上线
  2. TestFlight 事件

    • Beta 测试员提交的新 TestFlight 反馈
    • 构建处理完成
    • 测试员邀请状态变化

设置概述

  1. 创建和配置 Echobell 频道
  2. 为 App Store Connect 事件设置通知模板
  3. 获取您的 Echobell Webhook URL
  4. 在 App Store Connect 中创建和配置 Webhook
  5. 测试集成

分步指南

1. 创建 Echobell 频道

  1. 打开 Echobell 应用
  2. 创建新频道(例如"App Store Connect")
  3. 选择明显的颜色和图标以便于识别
  4. 添加应该接收应用状态通知的团队成员

2. 配置通知模板

设置能有效格式化 App Store Connect 事件的模板:

标题模板:

[{{app.name}}] {{eventType}} - {{status}}

正文模板:

📱 应用:{{app.name}}
🔄 事件:{{eventType}}
📊 状态:{{status}}
⏰ 时间:{{eventDate}}
💬 消息:{{message}}
🔗 在 App Store Connect 中查看

3. 获取您的 Echobell Webhook URL

  1. 在 Echobell 频道设置中,导航到 触发器 部分
  2. 复制提供的 Webhook URL
  3. 安全保存此 URL,因为它将在 App Store Connect 中配置

4. 配置 App Store Connect Webhook

根据 Apple 官方文档,按照以下步骤操作:

创建 Webhook

  1. 登录 App Store Connect
  2. 导航到 用户和访问权限
  3. 在侧边栏中点击 集成
  4. 其他 下,点击 Webhook
  5. 点击 Webhook 旁边的添加按钮 (+)
  6. 配置您的 Webhook:
    • 名称:输入描述性名称(例如"Echobell 通知")
    • 载荷 URL:粘贴您的 Echobell Webhook URL
    • 密钥:创建用于认证的安全密钥字符串
    • 应用:选择您要监控的应用
    • 事件触发器:选择您希望接收通知的事件

可用的事件触发器

根据您的监控需求选择这些事件类型:

应用版本事件:

  • App Store Version State Changed:当您的应用审核状态发生变化时
  • App Store Version Released:当您的应用版本在 App Store 发布时

TestFlight 事件:

  • TestFlight Beta Feedback:当 Beta 测试员提交反馈时
  • TestFlight Beta Review State Changed:当 TestFlight 审核状态发生变化时
  1. 点击 添加 创建 Webhook

5. 测试您的集成

  1. 创建 Webhook 后,使用 App Store Connect 的内置测试功能:

    • 在 Webhook 列表中,点击您新创建的 Webhook
    • 点击右上角的 测试
    • 测试 ping 将发送到您的 Echobell 频道
  2. 您应该在 Echobell 中收到事件类型为"Ping"的测试通知

高级配置

Webhook 安全性

为了增强安全性并验证 Webhook 真实性:

  1. 使用 HTTPS:Echobell Webhook URL 默认使用 HTTPS
  2. 密钥验证:使用您配置的密钥来验证传入请求
  3. IP 白名单:考虑将 Apple 的 Webhook 传送 IP 范围加入白名单

自定义通知模板

根据不同事件类型自定义您的模板:

对于应用状态变化:

  • 标题模板:
[{{app.name}}] 应用 {{eventType}}
  • 正文模板:
🍎 您的应用"{{app.name}}"状态已更改!

📊 状态:{{status}}
📅 日期:{{eventDate}}
  • 链接模板:
{{app.url}}

对于 TestFlight 反馈:

  • 标题模板:
[{{app.name}}] 新的 TestFlight 反馈
  • 正文模板:
📱 应用:{{app.name}}
👤 测试员:{{tester.name}}
⭐ 评分:{{rating}}/5
💬 反馈:{{feedback}}
📱 设备:{{device}}
  • 链接模板:
{{feedbackUrl}}

管理多个应用

对于管理多个应用的团队:

  1. 为每个应用或应用类别创建单独的频道
  2. 使用描述性命名约定(例如"MyApp - 生产"、"MyApp - Beta")
  3. 为不同应用配置不同的通知计划
  4. 设置基于角色的频道订阅

Webhook 载荷结构

App Store Connect 以 JSON 格式发送 Webhook 载荷。典型结构如下:

{
  "eventType": "APP_STORE_VERSION_STATE_CHANGED",
  "apiVersion": "v1",
  "eventId": "12345678-1234-1234-1234-123456789012",
  "eventDate": "2025-01-15T10:30:00Z",
  "data": {
    "app": {
      "id": "1234567890",
      "name": "我的出色应用",
      "bundleId": "com.example.myapp"
    },
    "appStoreVersion": {
      "id": "987654321",
      "versionString": "1.2.0",
      "appStoreState": "READY_FOR_SALE"
    }
  }
}

管理 Webhook

查看 Webhook 传送

在 App Store Connect 中监控您的 Webhook 性能:

  1. 转到 用户和访问权限集成Webhook
  2. 点击您的 Webhook
  3. 查看 最近传送 部分以查看:
    • 事件 ID 和类型
    • 传送状态(成功、待处理、失败)
    • 创建日期
    • 响应详情

Webhook 传送状态

状态描述
成功Webhook 已成功传送到 Echobell
待处理Webhook 正在传送过程中
失败Webhook 传送失败(可以重新发送)

重新发送失败的传送

如果 Webhook 传送失败:

  1. 在最近传送表中,找到失败的传送
  2. 点击失败事件旁边的 重新发送
  3. 将进行新的传送尝试

修改 Webhook 设置

您可以随时更新 Webhook 设置:

  1. 点击您要修改的 Webhook
  2. 更新名称、密钥、载荷 URL 或事件触发器
  3. 点击 保存
  4. 更改立即生效

临时禁用 Webhook

要暂停通知而不删除 Webhook:

  1. 点击 Webhook
  2. 点击 关闭 Webhook
  3. 点击 确认
  4. 要重新启用,点击 打开 Webhook

使用案例和示例

开发团队工作流程

场景 1:应用发布监控

  • 监控您的应用从"审核中"变为"可销售"的时间
  • 当新版本对用户可用时立即收到通知
  • 跟踪整个提交和审核过程

场景 2:TestFlight Beta 管理

  • 从 Beta 测试员获得即时反馈
  • 监控 Beta 构建处理状态
  • 跟踪测试员参与度和反馈趋势

场景 3:多应用组合管理

  • 为不同应用设置单独频道
  • 为团队成员配置基于角色的通知
  • 为利益相关者创建摘要报告

通知策略

对于小团队:

  • 所有应用事件使用单一频道
  • 包含所有团队成员
  • 使用包含完整上下文的详细模板

对于大型组织:

  • 按应用和环境分离频道
  • 基于角色的频道访问(开发者、QA、营销)
  • 关键事件的升级频道

故障排除

常见问题

未收到通知:

  1. 验证 Webhook URL:确保 Echobell Webhook URL 配置正确
  2. 检查事件触发器:确认您已选择适当的事件类型
  3. 查看传送状态:检查 App Store Connect 的最近传送中的错误
  4. 验证频道状态:确保您的 Echobell 频道处于活跃状态
  5. 确认订阅:验证团队成员已订阅频道

Webhook 认证错误:

  1. 密钥不匹配:验证在 App Store Connect 中配置的密钥符合您的期望
  2. URL 可访问性:确保 Echobell Webhook URL 可公开访问
  3. SSL 证书:确认 HTTPS 连接正常工作

缺少事件数据:

  1. 模板变量:检查您的通知模板使用正确的变量名称
  2. 事件类型过滤:验证您已订阅正确的事件类型
  3. 载荷解析:查看 Webhook 载荷结构中的可用数据字段

测试 Webhook

使用 App Store Connect 测试功能:

  1. 在 App Store Connect 中导航到您的 Webhook
  2. 点击 测试 按钮
  3. 验证您在 Echobell 中收到 ping 通知

手动测试:

  1. 提交应用更新或 TestFlight 构建
  2. 监控 Webhook 传送状态
  3. 检查 Echobell 通知的正确格式

速率限制和性能

  • App Store Connect 可能对 Webhook 传送实施速率限制
  • Echobell 高效处理 Webhook 处理以最小化延迟
  • 配置多个 Webhook 时考虑通知频率

最佳实践

安全性

  1. 保持 Webhook URL 私密:不要公开分享您的 Echobell Webhook URL
  2. 使用强密钥:为 Webhook 认证创建复杂、唯一的密钥
  3. 监控传送日志:定期查看 Webhook 传送状态
  4. 定期轮换密钥:为了安全定期更新 Webhook 密钥

组织

  1. 一致的命名:为 Webhook 和频道使用清晰、描述性的名称
  2. 文档化:记录您的 Webhook 配置供团队参考
  3. 频道组织:将相关通知分组到适当的频道中
  4. 访问控制:基于团队角色管理频道订阅

监控

  1. 定期健康检查:定期测试 Webhook 以确保它们正常工作
  2. 性能监控:跟踪 Webhook 传送成功率
  3. 错误警报:为 Webhook 传送失败设置通知
  4. 容量规划:监控通知量并相应调整

API 集成

对于高级用例,您还可以使用 App Store Connect API 以编程方式管理 Webhook。这允许您:

  • 为新应用自动化 Webhook 创建
  • 以编程方式更新 Webhook 配置
  • 将 Webhook 管理集成到您的 CI/CD 管道中
  • 监控 Webhook 性能指标

相关资源

结论

将 App Store Connect Webhook 与 Echobell 集成提供了对您的应用状态和 TestFlight 反馈的实时可见性。这种集成帮助开发团队了解关键应用事件,快速响应审核反馈,并在整个应用开发生命周期中保持更好的沟通。

App Store Connect 可靠的 Webhook 传送与 Echobell 灵活的通知系统相结合,为各种规模的 iOS 应用开发者和团队创建了强大的监控解决方案。