メインコンテンツへ移動
このページはAIによって翻訳されました。

Webhook

カスタムWebhookで読書イベントを任意のURLに送信します。独自の自動化や連携を構築するのに最適です。

Book Reading Habit app showing webhook configuration screen

Webhook設定画面

Webhookを使用すると、読書アクティビティに関するリアルタイム通知を受け取ることができます。イベントが発生すると、Book Reading HabitはJSON形式のイベントデータを指定したURLにHTTP POSTリクエストで送信します。

Webhookとは?

Webhookを使用すると、読書アクティビティに関するリアルタイム通知を受け取ることができます。イベントが発生すると、Book Reading HabitはJSON形式のイベントデータを指定したURLにHTTP POSTリクエストで送信します。

Webhookの仕組み

Webhook URLを設定すると、特定のイベントが発生するたびにBook Reading Habitが自動的に通知を送信します:

  • Book Reading Habitでイベントが発生(例:読書セッションの完了)
  • アプリがWebhook URLにHTTP POSTリクエストを送信
  • サーバーがJSONペイロードを受信し、任意の方法で処理できます

設定

以下の設定でWebhookを構成してください:

Webhook名

このWebhookを識別するためのフレンドリーな名前

Webhook URL

POSTリクエストが送信されるURL

シークレットキー(任意)

指定した場合、リクエストには検証用のHMAC署名を含むX-Signature-256ヘッダーが含まれます

イベント

このWebhookをトリガーするイベントを選択してください

ペイロード形式

すべてのWebhookペイロードは、以下の構造でJSONとして送信されます:

{
  "eventType": "session.completed",
  "timestamp": "2024-12-04T10:30:00Z",
  "book": { ... },
  "session": { ... },
  "metadata": null
}

詳細を見る

セキュリティのベストプラクティス

常にHTTPS URLを使用し、Webhookリクエストを検証するためのシークレットキーを設定してください。シークレットキーは、サーバーで検証できるHMAC署名を生成するために使用されます。