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"
}
Updated 10 months ago
What’s Next