Webhook

活動目錄

詢問 API 您可以訂閱哪些事件。目錄源自即時自動化觸發的真實資料來源，因此僅列出今天實際觸發的事件，並按生命週期階段（獲客、互動、忠誠度、留存、商務、擁護）分組，每個事件都包含其事件鍵、描述和範例有效負載。回應還記錄了共享有效負載信封和簽名標頭。

curl https://flash.socialhub.ai/api/v2/events/catalog \
  -H "Authorization: Bearer fl_live_..."

# { "data": { "events": [
#     { "event": "member.created", "label": "Member created",
#       "stage": "acquisition", "examplePayload": { ... } },
#     { "event": "loyalty.tier_upgraded", "label": "Tier upgraded",
#       "stage": "loyalty", "examplePayload": { ... } },
#     ...
#   ],
#   "payload": { "schema": { ... }, "headers": { ... } }
# } }

訂閱時，將事件的 event 鍵直接放入 eventTypes array 中。需要 webhooks:manage 權限範圍。

驗證每個簽名

Flash 使用 標準 Webhook (HMAC-SHA256)，透過端點的 whsec_ 金鑰對每個交付進行簽署。重新計算 {webhook-id}.{webhook-timestamp}.{body} 的簽名，並在恆定時間內與 webhook-signature 標頭進行比較。拒絕任何不匹配的交付，並拒絕過舊而無法防禦重播攻擊的 webhook-timestamp 密鑰。根據規範，簽章金鑰是 whsec_ 前綴之後的金鑰的 base64 解碼位元組。在金鑰輪換期間，標頭包含多個以空格分隔的 v1,… 值——如果 中有任何 匹配，則接受交付。

import crypto from "node:crypto";

// req.body must be the RAW, unparsed request body string.
function verifyFlashWebhook(headers, rawBody, whsec) {
  const id = headers["webhook-id"];
  const ts = headers["webhook-timestamp"];
  const sigHeader = headers["webhook-signature"]; // "v1,<b64> v1,<b64> ..."

  // reject stale deliveries (5 min tolerance)
  if (Math.abs(Date.now() / 1000 - Number(ts)) > 300) return false;

  const key = Buffer.from(whsec.replace(/^whsec_/, ""), "base64");
  const expected = crypto
    .createHmac("sha256", key)
    .update(`${id}.${ts}.${rawBody}`)
    .digest("base64");

  return sigHeader
    .split(" ")
    .map((p) => p.split(",")[1])
    .some((sig) =>
      sig &&
      sig.length === expected.length &&
      crypto.timingSafeEqual(Buffer.from(sig), Buffer.from(expected)),
    );
}