Hook v2は、KARTE内で発生したイベントをトリガーとして、指定したチャネルへデータをリアルタイムに送信する機能です。
WebhookやAmazon EventBridgeを利用した外部システムへの通知に加えて、イベントをトリガーとしてCraft Functionsを実行できます。
Hook v2の構成
Hook v2は、処理を開始する「トリガー」と、データの送信先となる「チャネル」を組み合わせて設定します。
- トリガー
- KARTE Talkのメッセージ送信、Datahub Jobflowの開始・終了、KARTE Craftの操作など
- チャネル
- Webhook、Amazon EventBridge、KARTE Craft
トリガー
以下のトリガーが選択可能です。
| トリガー | 必要な Scope | type | 詳細 |
|---|---|---|---|
| KARTE Talk: ユーザーからのメッセージ送信時 | talk.message.get | talk/message/sendFromUser | Message Hook |
| KARTE Talk: オペレーターからのメッセージ送信時 | talk.message.get | talk/message/sendFromOperator | Message Operator Hook |
| KARTE Talk: オペレーターのアサイン時 | talk.operator.get | talk/assignee/assign | Assign Hook |
| KARTE Datahub: ジョブフローの開始時 | datahub.jobflow.get | datahub/jobflow/start | Jobflow Hook |
| KARTE Datahub: ジョブフローの終了時 | datahub.jobflow.get | datahub/jobflow/end | Jobflow Hook |
| KARTE Craft | トリガーによって異なります | トリガーによって異なります | KARTE Craft関連トリガー |
※ type は何をトリガーに送信されたか特定するための識別子です
チャネル
データ送信の手段として、現在ご利用いただけるチャネルは以下の通りです。
| チャネル | 説明 | 詳細 |
|---|---|---|
| Webhook | イベントが発生すると、指定した URL に HTTP リクエストを送信 | Webhook 連携 |
| Amazon EventBridge | イベント情報を AWS が提供するイベントバスサービス「Amazon EventBridge」に送信 | Amazon EventBridge 連携 |
| KARTE Craft | イベントが発生すると、指定したイベント駆動タイプのCraft Functionsを実行 | KARTEのHook機能から実行する（Hook v2） |
重複排除
Hook v2 ではデータが複数回送信される可能性があります。
そのため、リクエストに含まれる ユニークな id を使用して、重複して送信されたデータでないかのチェックを行うことを推奨します。
各トリガーのリリースステージについて
トリガーのリリースステージは、依存するScopeのリリースステージに応じます。
必要なAPIスコープが beta.xxx.yyyのようにbetaスコープになっているものは、そのAPI同様、トリガー自体も予告なく変更が入る場合などがあります。
Hookのステータスについて
API v2で設定されているHookでエラーが発生した際には、対象のHookのステータスが「無効」になります。再度、ステータスを「有効」にする場合は、設定を確認の上で「有効」にしてください。