KARTEの接客サービスの配信条件を使って、外部サービスに対してリアルタイムにWebhookリクエストを送信することができます。

概要

null

できること

  • KARTE上で特定の条件を満たすユーザーに特定の条件を満たすイベントが発生した場合のみ、任意の外部サービスのAPIエンドポイントに対してHTTPリクエストを送信する
  • HTTPリクエストの中に、当該ユーザーの任意のユーザー情報を含めて外部連携する

主な制約

  • KARTE Craftを利用して実現するため、KARTE Craft側の機能制約を受けます
    • 特に、Craftの契約プランに応じた「月間実行数上限」の範囲内で利用する必要があります
      • 2023年7月現在、Craftの無償プランにおける実行数上限は「100万リクエスト/月」です

初期設定手順

最初に一度だけ下記設定を実施してください。

KARTE Craftを有効化する

  • KARTE Craftが有効化されていないプロジェクトでは、事前に有効化が必要です
  • サポートや営業担当までお問い合わせください

Webhook用のファンクションを作成する

Webhook用接客サービスから利用するCraft Functionsのファンクションを作成します。

※ここで作成したファンクションは複数の接客サービスから利用されます。ファンクションの作成は1度だけで問題ありません。

null

  • ファンクションを保存します

Webhook用接客サービスの作成手順

接客サービスを下記手順で作成します。
Webhookのルールを増やしたい場合は、その度に同様の手順で接客サービスを追加してください。

1. 接客サービスを新規作成する

Webhook用の接客サービスを新規に作成します。

  • ナビゲーションメニューから [すべてのプロダクト > Craft > ファンクション] を開きます
  • 右上の[作成]ボタンから接客サービス作成画面を開きます
  • 接客サービス名などを設定します
  • [アクションを追加] からテンプレート一覧を開き、 Craft Functions連携(Webhook用) テンプレートからアクションを追加します

null

2. アクション設定をする

アクション設定画面から、リクエスト内容に関する設定をします。

  • ファンクション名
    • 作成したCraftのファンクション名を指定します
  • data
    • 外部サービスに送信するリクエストの内容に関する設定をJSON形式で指定します

null

dataの設定方法

項目 説明
url HTTPリクエストを送信するURLを指定します
hookData 送信するリクエストbodyをJSON形式で自由に指定します。ユーザー情報変数を利用してユーザーデータを埋め込むこともできます
method HTTPメソッド名を指定します。デフォルトはPOSTです
headers HTTPヘッダーをJSON形式で自由に指定します
logLevel Craft Functions側のログレベルを指定します。デフォルトはERRORに設定し、トラブルシューティング時のみINFOを指定してください
campaignId Craft Functions側に接客サービスIDを連携するための項目です。特に変更は不要です

設定例

{ 
    "url": "https://example.com/api",
    "hookData": {
        "user_id": "#{user_id}",
        "viewed_path": "#{viewed_path}"
    },
    "method": "POST",
    "headers": {"Content-Type": "application/json; charset=UTF-8"},
    "logLevel": "ERROR",
    "campaignId": "#{campaign_id}"
}

3. 配信設定をする

接客サービスの残りの配信設定をします。

  • 主な配信設定項目
    • A/Bテストをしない場合は、アクションの「配信率」を100%にします
    • 「対象ユーザー」や「対象イベント」の設定を変更し、Webhookが送信される条件を指定します
    • 「同時配信」をOKにします

なお、動作検証が完了するまでは「対象ユーザー」をテストユーザーに限定することを推奨しています。

4. 動作検証する

接客サービスを公開し、意図通りに動作していることを確認します。

うまく動作しない場合は、次のようにトラブルシューティングしてください。

  • アクション設定でlogLevelをINFOに変更します
  • Craft Functionsの作成したファンクション画面を開き、出力されたログを見てエラーログなどが出ていないか確認します

関連リンク