Hook v2

Hook v2 で Craft Functions を実行します。

Hook v2 のトリガーには以下の種類があります。

• KARTE TALK のメッセージ送信
• KARTE TALK の担当者変更
• Datahub Jobflow の開始・終了

設定手順

以下の手順で Craft Functions の Hook v2 トリガーを設定します。この設定により、KARTE TALK のメッセージ送信や Datahub ジョブフローの開始終了といった各種トリガーから Function を実行することができます。

• アプリを利用する を参考に API v2 アプリを作成します。
  • 利用するトリガーに応じて Scope を設定します。
  • Talk 関連 Hook
  • Datahub 関連 Hook
• 作成したアプリの詳細画面を開きます。
• 「hook 設定」タブで「編集」を選択し、トリガーと実行する Function を指定して「保存」を選択します。

Craft Functions に送信されるデータ

data のフォーマットは Function 実行時に送信されるデータ をご確認ください。

• kind は `“karte/apiv2-hook” が入ります。
• jsonPayload のフォーマットはHook v2 概要 の各 Hook の Request Body をご確認ください。

例

Message Hook で Funciton を実行した場合の data の例です。

{
  "id": "3218655a-83e5-4a2d-a298-d5f56e58c365",
  "kind": "karte/apiv2-hook",
  "jsonPayload": {
    "id": "0759a6b7-cd92-458c-ae04-82ac86131b52",
    "data": {
      "content": {
        "text": "test message",
        "image": null
      },
      "sender_id": null,
      "account_id": null,
      "date": "2023-02-20T07:07:46.237Z",
      "user_id": "",
      "visitor_id": "vis-xxxxxxxxxxx",
      "profile_name": null
    },
    "extra": {
      "access_uri": {
        "protocol": "https",
        "url": "https://example.com/",
        "host": "example.com",
        "query": "",
        "queryKey": {},
        "anchor": "test",
        "path": "/"
      }
    },
    "event_type": "talk/message/sendFromUser",
    "api_key": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "client_id": "xxxxxxxxxxxx"
  },
  "timestamp": "2023-02-20T07:07:48.125Z"
}