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

概要

できること

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

KARTE Craftとは？

KARTE CraftはKARTE内で発生するユーザーの状態の変化をトリガーとして、汎用のプログラムを実行するための機能です。詳しくは下記ページをご覧ください。

• サービスサイト
  • https://ecosystem.plaid.co.jp/product/karte-craft
• ドキュメント
  • https://developers.karte.io/docs/what-is-karte-craft

主な制約

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

初期設定手順

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

KARTE Craftを有効化する

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

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

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

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

• ナビゲーションメニューから [すべてのプロダクト > Craft > ファンクション] を開きます
• 右上の[作成 > テンプレートから作成]ボタンを押し、ファンクション作成画面を開きます

• 次のようなワードでテンプレートを検索します
  • Web上のユーザー行動をトリガーにして外部にWebhookリクエストを飛ばしたい
• 検索結果から次のテンプレートを探し、[取得]ボタンを押します
  • Web 上のユーザー行動をトリガーにして外部に Webhook リクエストを飛ばす

• 取得されたプログラム下部の[反映]ボタンを押します
• ファンクション名を webhook_action などと入力して[保存]し、ファンクションを右上の[保存]ボタンで保存します
  • ※ファンクション名を変更した場合は、後述する接客アクションの設定で入力するファンクション名と一致させてください

• 保存が完了したら画面を更新し、[設定 > ファンクションの有効化]にチェックを付けて再度 [保存]ボタンを押します

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

Webhookリクエストのルール（どんな条件でどこにHTTPリクエストを送信するのか）を追加するには、その度に下記手順で接客サービスを作成してください。

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

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

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

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

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

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

dataの設定方法

設定例

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

3. 配信設定をする

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

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

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

4. 動作検証する

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

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

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

関連リンク

• Web上のユーザー行動をトリガーにして外部にWebhookリクエストを飛ばす