Webhook

Webhook 允许 Trimoji 在事件发生时（例如测试结束、活动创建等）向您的应用程序发送实时通知。这是同步数据的最有效方法，同时避免不必要的 API 调用。

工作原理：当事件发生时，Trimoji 会向您配置的 URL 发送一个 HTTP POST 请求，并附带相应的数据。

步骤 1

Webhook 配置

Webhook 的管理在您的客户界面进行：Trimoji 我的账户。

配置步骤：

输入您服务器的目标 URL（例如：https://your-site.com/api/webhook）。
选择您想监听的事件。
验证添加。
重要：创建 Webhook 后，Trimoji 会自动生成一个唯一的密钥 (Token)。您需要获取此 Token 来保护您的端点。

步骤 2

安全与认证

每次发送时，Trimoji 使用生成的密钥来签名和认证请求。您需要在服务器端验证此信息，以确保请求确实来自我们的服务。

Token 通过以下两种方式在每次请求中传递：

在 HTTP 头部：Authorization: YOUR_GENERATED_TOKEN
在 JSON 体中：{ "_token": "YOUR_GENERATED_TOKEN", ... }

步骤 3

负载（Payload）结构

Trimoji 发送的所有请求都遵循标准化的 JSON 格式，以便快速识别操作。

{
  "_token": "trimoji_generated_token",
  "_timestamp": "2026-02-11T16:00:00.000Z",
  "_event": "QUIZZ_COMPLETED",

  // 根据事件的动态数据
  "id": 12345,
  "data": { ... }
}

步骤 4

可用事件列表

您可以根据您的自动化需求订阅不同类型的操作：

测试与评估

QUIZZ_SENT
QUIZZ_COMPLETED

候选人与画像

PROFILE_UPDATED
PROFILE_DELETED
PROFILE_RESTORED

活动与 Personi

CAMPAIGN_CREATED / UPDATED
PERSONI_CREATED

安全与流量

AUTH_LOGIN
TRANSFER_INCOMING

步骤 5

技术规范

User-Agent：请求发送时使用标识符trimoji/1.0.0。
预期响应：您的服务器应返回200 OK状态码。如果您的服务器出现错误，Trimoji 会在您的账户日志中记录失败。
格式：请求体始终为JSON格式。