Webhook

Webhookは、サイトで何らかのイベント（投稿の公開、フォームの送信、注文の支払いなど）が発生した際に、システムへ通知を送る仕組みです。Kanorioは、イベントを購読している各エンドポイントに対して、JSON形式のボディを含むHTTPS POSTリクエストを送信します。

エンドポイントの追加

エンドポイントはサイト設定 › Webhookから追加するか、Management APIの POST /sites/{id}/webhooks を使用して追加できます。各エンドポイントで以下を設定します。

• イベント: イベントリファレンスには、製品ごとにグループ化されたすべてのイベントと、必要な権限が記載されています。
• フィルタ: コレクションイベントは特定のコレクションに、フォームイベントは特定のフォームに限定できます。
• 署名シークレット: 各エンドポイントには、署名を検証するための固有の whsec_ シークレットが割り当てられます。

サイトごとのエンドポイント数はプランによって異なります。レート制限とクォータをご確認ください。

リクエスト

すべてのイベントは共通のエンベロープを使用します。イベント固有のフィールドは data 内に格納されます。

{
  "version": "1",
  "id": "3f9c2a8b1e4d7c0f9a2b3c4d5e6f7a8b",
  "event": "collections.item.published",
  "occurredAt": "2026-11-02T08:30:00.000Z",
  "websiteId": "ws_example123",
  "title": "Collection item published: Sourdough Guide",
  "summary": "blog/sourdough-guide (published)",
  "data": {
    "collectionKey": "blog",
    "itemId": "item_01",
    "slug": "sourdough-guide",
    "status": "published",
    "publicVersion": "1729500000000",
    "cacheTags": ["collection:blog", "item:item_01", "seo", "search"]
  },
  "actionUrl": "https://app.kanorio.com/data/blog",
  "operationId": null,
  "principal": { "kind": "USER", "id": "usr_example01" }
}

署名の検証

エンドポイントのシークレットを使用して {t}.{rawBody} のHMAC-SHA256を計算し、各 v1 値と定数時間で比較します。t が現在時刻から5分以上経過しているリクエストは拒否してください。JSON解析を行う前の、生の（raw）リクエストボディを必ず使用してください。

署名シークレットをローテーションする際、Kanorioは 24 hours の間、新旧両方のシークレットで署名を行うため、ヘッダーには2つの v1 値が含まれます。いずれかが一致すればリクエストを承認してください。

SDKを使用すると、この処理を自動化できます。

import { verifyWebhookSignature } from "@kanorio/sdk";

export async function POST(request: Request) {
  const rawBody = await request.text();
  const valid = await verifyWebhookSignature({
    rawBody,
    signatureHeader: request.headers.get("x-kanorio-signature"),
    signingSecret: process.env.KANORIO_WEBHOOK_SECRET!,
  });
  if (!valid) return new Response("Invalid signature", { status: 401 });

  const event = JSON.parse(rawBody);
  // handle event.event and event.data
  return new Response(null, { status: 200 });
}

SDKを使用しないNode.jsでの実装例は以下の通りです。

import { createHmac, timingSafeEqual } from "node:crypto";

export function verifyKanorioWebhook(rawBody, header, secret) {
  if (!header || !secret) return false;
  const parts = header.split(",").map((part) => part.split("="));
  const t = parts.find(([key]) => key === "t")?.[1];
  const signatures = parts.filter(([key]) => key === "v1").map(([, value]) => value);
  if (!t || signatures.length === 0) return false;
  if (Math.abs(Date.now() / 1000 - Number(t)) > 300) return false;

  const expected = Buffer.from(createHmac("sha256", secret).update(`${t}.${rawBody}`).digest("hex"));
  return signatures.some((v1) => {
    const actual = Buffer.from(v1);
    return actual.length === expected.length && timingSafeEqual(actual, expected);
  });
}

応答と再試行

• 8 seconds 以内に 2xx を返してください。処理に時間がかかる場合は、イベントをキューに入れ、先に応答を返してください。
• Kanorioはリダイレクトに従いません。3xx は失敗とみなされるため、フレームワークが期待する末尾のスラッシュを含め、最終的なURLを登録してください。
• タイムアウト、ネットワークエラー、429、5xx エラーが発生した場合、1m, 5m, 30m, 2h, 8h, 1d, 1d の間隔で 7 回再試行されます。再試行のたびに、新しいタイムスタンプで署名が再生成されます。
• 410 Gone が返されると、エンドポイントは直ちに無効化されます。3 回連続で配信に失敗すると、エンドポイントは一時停止され、サイトチームに通知されます。
• 配信ペイロードは 7 days 間保持されるため、その期間内であれば管理画面から配信を再送できます。

各配信を一度だけ処理する

再試行や手動での再送により、同じイベントが複数回配信される可能性があります。処理済みの X-Kanorio-Delivery IDを保存しておき、同じIDを検知した場合は処理を行わずに 200 を返してください。

フロントエンドのキャッシュを更新する

Content Delivery APIのすべての応答には X-Kanorio-Cache-Tags に依存関係が記載されており、すべてのコンテンツイベントの data.cacheTags にも同じタグを使用して変更内容が記載されています。フレームワークのキャッシュに応答タグを付与し、イベントタグを再検証することで、変更されたコンテンツを使用したページのみが数秒以内に更新され、それ以外のキャッシュは保持されます。

タグにはロケールコードを使用し、URLプレフィックスは使用しないでください（所有者がプレフィックスを変更する可能性があるため）。revalidateTag は完全一致で照合されるため、イベントには常に具体的なタグが記載されます。単一レコードのイベントには site:<id> は含まれません。サイトタグのみでキャッシュを管理する場合は content.site.published を購読するか、より適切には、各フェッチに応答独自のタグを付与してください。

Next.jsでは、createRevalidateHandler を使用すると、署名の検証とタグの再検証を1行で行うことができます。すべてのタグに kanorio: というプレフィックスが付与されるため、Kanorioのタグと独自のタグが競合することはありません。frameworkCacheTags または cacheTag ビルダーを通じてフェッチにタグを付与し、両側で一致するようにしてください（生のタグを使用する場合は tagPrefix: "" を渡します）。

// app/api/revalidate/route.ts
import { revalidateTag } from "next/cache";
import { createRevalidateHandler } from "@kanorio/sdk";

export const POST = createRevalidateHandler({
  signingSecret: process.env.KANORIO_WEBHOOK_SECRET!,
  revalidateTag: (tag) => revalidateTag(tag),
});

静的に構築されたサイトの場合は、Webhookをホストのデプロイフックに向け、コンテンツイベントを購読してください。