アドバンストKDP でのウェブフックについて理解する

このページで学べること

Webhook と、Klaviyo でキャプチャされたイベントに応じてサードパーティアプリケーションに情報を送信するための使用方法について学びます。システム Webhook の受信方法について詳しくは、システム Webhook の利用に関する開発者向けリソースをご覧ください。

This content requires Functional cookies to be enabled.

Update Cookie Settings

Webhook とは何ですか？

Webhook を使用すると、Klaviyo は HTTP リクエストを介して情報を渡したり、他のアプリケーション、ツール、サーバーを「呼び出し」たりできます。Webhook では、発生したイベント（例：注文の確定、新しい顧客の購読など）に関する情報を送信したり、外部システムに対してイベントが発生したことを通知したりできます。

Klaviyo は 2 種類のウェブフックをサポートしています：

1. アドバンストKDP のウェブフック
   アドバンストKDP の一部として利用できるウェブフックは、特定のイベントが発生したことを外部システムに通知し、フロー内であることの制限を受けずに、幅広いイベントに応じて情報を送信できるようにします。
2. フロー Webhook
   フロー Webhook はフローのインターフェース内でのみ利用でき、フローが特定のステージまたはステップに到達するとトリガーされます。フローをトリガーしたイベントまたは受信者に関するデータを送信するために使用できます。

Webhook の主な構成要素

ウェブフックはいくつかの主要なコンポーネントで構成されています：

• トピック
  Webhook が起動する原因となるイベント
• 本文（または「ペイロード」）
  Webhook が送信するデータ
• ヘッダー
  追加情報（認証など）を渡すための場所

アドバンストKDP のウェブフックは、フローウェブフックとどのように異なりますか？

ニーズに応じて、アドバンストKDP のウェブフックまたはフローウェブフックを使用できます。

含まれるイベント

フローウェブフックは、Klaviyoイベントの一部にのみ応答でき、フローは通常メッセージの受信で終了し、それらから開始するわけではないため、「購読解除」、「メール受信」、「メールをクリック」などのメッセージ関連イベントはサポートしていません。一方、アドバンストKDP のウェブフックでは、アカウント内の任意のイベントに応じて情報を送信できます。

以下のようなブロックが用意されています。

• メールイベント（例: メールを受信、メールをクリック、メールをスパムとしてマーク、購読解除）
• SMS イベント（例：Sent SMS、Received SMS）
• プッシュ通知イベント（例：プッシュ受信、プッシュのバウンス）
• 外部連携からのイベント（例：Klaviyo によって作成されたファーストパーティ外部連携からのイベント）
• API イベント（例：Klaviyo の API を通じて同期されたイベント）

ペイロード

フローウェブフックでは、リクエストに含めるデータをカスタマイズできますが、ペイロードは手動で構築する必要があります。一方、アドバンストKDP の ウェブフック では、事前構築済みのペイロードが使用されるため、ユーザー側で手動作業は不要です。また、イベントが発生したことを外部システムに通知するために使用されます。

フローの制限事項

フローのウェブフックはフローインターフェイス内で設定する必要があり、複数のトリガーを同時に使用することはできません。トリガーは個別のフローで作成する必要があり、フローの全体的なステータスに依存します（例：下書きのフローはフロー ウェブフック を通じてデータを送信しません）。一方、アドバンストKDP の ウェブフック はフロー インターフェースの外部に存在し、フロー ウェブフック のように ウェブフック アクションに至るまでの一連のステップには依存しません。

Webhook を設定

Klaviyoでウェブフックを設定するには、Klaviyo のアドバンストKDPで[データ管理] > [ウェブフック]と移動します。

新しい Webhook を追加するには、[Webhook を作成] ボタンをクリックしてください。

1. Webhook を作成モーダルで、情報を入力します。これには以下が含まれます：
   • 名前
     Webhook を識別する方法
   • エンドポイント URL
     Webhook リクエストの宛先に関連付けられた URL
   • シークレットキー
     他のシステムで Klaviyo の Webhook リクエストを識別するための一意の識別子
   • 説明
     Webhook の任意の説明。
2. Topics セクションで、Webhook 通知をトリガーするイベントを選択します。

Webhook を作成すると、Webhook ページに次の項目とともに一覧表示されます：

• Webhook 名
• Webhook の URL
• 最新の同期時刻
• ステータス

項目の横にあるメニューを使用して、Webhook を削除または無効化できます。

システム Webhook のテスト

Klaviyo で Webhook を設定する際に、接続が成功していることを確認するためにテストできます。Webhook をテストするには、必須フィールドを入力した後、[接続をテスト] ボタンを使用します。

トピックを選択してコールバック URL にテストを送信できるメニューが表示されます。

テストを実行すると、成功したかどうかを示すメッセージが表示されます。また、Response タブにはリクエストのヘッダーと本文が入力された状態で表示されます。

ペイロードの例

以下は、Email delivered トピックに対する応答として送信される Webhook リクエストのペイロード例です。

{
  "meta": {
    "timestamp": "2023-08-10T07:25:23.700369+00:00",
    "klaviyo_webhook_id": "ID",
    "version": "2023-06-03"
  },
  "data": [
    {
      "topic": "event: email_delivered",
      "external_id": "ID",
      "payload": {
        "data": {
          "id": "ID",
          "type": "event",
          "links": {
            "self": "https://a.klaviyo.com/api/events/ID/"
          },
          "attributes": {
            "uuid": "96150200-374e-11ee-8001-a163313bc6c2",
            "datetime": "2023-08-10 07:21:56+00:00",
            "timestamp": 1691652116,
            "event_properties": {
              "$ESP": 0,
              "Subject": "? Free (Cool!) Swag Alert ?",
              "$message": "01H7F525FKR31P27Y7PNGVBBKK",
              "$event_id": "01H7F525FKR31P27Y7PNGVBBKK:125423419905414052533228990613763937641",
              "$group_ids": [
                "V7adxq"
              ],
              "$attribution": {
                "$send_ts": 0,
                "$attributed_event_id": ""
              },
              "Email Domain": "klaviyo-demo.com",
              "Campaign Name": "Daily Newsletter: 2023-08-10",
              "Inbox Provider": "Amazon SES Inbound",
              "$_cohort$message_send_cohort": "1691652081:01H7F525FKR31P27Y7PNGVBBKK"
            }
          },
          "relationships": {
            "metric": {
              "data": {
                "id": "ID",
                "type": "metric"
              },
              "links": {
                "self": "https://a.klaviyo.com/api/events/ID/relationships/metric/",
                "related": "https://a.klaviyo.com/api/events/ID/metric/"
              }
            },
            "profile": {
              "data": {
                "id": "ID",
                "type": "profile"
              },
              "links": {
                "self": "https://a.klaviyo.com/api/events/ID/relationships/profile/",
                "related": "https://a.klaviyo.com/api/events/ID/profile/"
              }
            }
          }
        }
      }
    },
  

その他のリソース