Webhook
Webhook 是 IDCloud 在身份验证流程中发生某些事情时自动通知您系统的方式。您的系统不再需要询问"完成了吗?", IDCloud 会在事件发生的那一刻调用您的 API。
在此屏幕上,您可以设置您 API 的地址、IDCloud 如何针对它进行认证,以及当它无响应时会发生什么。
信息
适用对象: 希望自动接收流程结果、而不进行轮询的客户。适用于所有集成类型。
您系统中会发生什么变化: 现在它会在每次状态变化时收到通知,而不需要轮询 IDCloud。
在哪里找到它: IDCloud Portal → 侧边栏 设置(Settings) → Webhook 选项卡。
开始之前
访问权限
您的用户需要具有 Configurator(配置员) 权限档案——与授予 Journey Customization 访问权限的档案相同。 如果 Webhook 选项卡没有显示出来,请联系您的账户管理员。
配置如何生效
| 范围 | 每个**租户和分支(tenant and branch)**一个 Webhook。没有列表:如果已经配置了一个,会对其进行编辑,而不是重复创建。 |
| 独立的环境 | Staging Portal 配置的是 UAT 的 Webhook;Production 则配置 Production 的。配置其中一个不会影响另一个。 |
| 何时生效 | 保存后立即生效。 |
| 密钥安全性 | 密钥经过加密,且不会再以明文显示。屏幕上始终以掩码形式显示。 |
需要提前准备的 内容
- 用于接收通知的 API 的 HTTPS URL。在保存之前,它需要处于可用状态并能够接受请求。
- 您 API 所期望的凭据,具体取决于您选择的认证方式(见步骤 3)。
- 如果您的 API 有容量限制,需要知道它支持的每秒请求数。
需要提前决定的事项
有两项技术决定取决于维护您 API 的人,而不是操作 Portal 的人。在打开此屏幕之前,值得先对齐:
- 您的 API 要求使用哪种认证方式。
- 是否需要调整重试策略,还是保留默认设置。默认设置适用于大多数情况。
分步操作
步骤 1 — 打开 Webhook 选项卡
在 IDCloud Portal 中,点击侧边栏中的齿轮图标(设置),然后选择 Webhook 选项卡。
如果您还没有配置 Webhook,屏幕会显示**"