KARTE 内で発生した特定の変更や追加などの変化をトリガーにして、そのデータをリアルタイムに外部のシステムに送信することができます。
これにより、外部システムでKARTE をトリガーにした処理の実行が可能になります。
チャネル
データ送信の手段（ここでは "チャネル" と呼びます）として、現在ご利用いただけるチャネルは以下があります。
| チャネル | 説明 | 詳細 |
|---|---|---|
| Webhook | イベントが発生すると、指定した URL に HTTP リクエストを送信 | |
| Amazon EventBridge | イベント情報を AWS が提供するイベントバスサービス「Amazon EventBridge」に送信 | |
| KARTE Craft | イベントが発生すると、指定したCraft Functionsを起動 | KARTE Craft Hook v2 トリガー |
トリガー一覧
現在、以下のトリガーが選択可能です。
| トリガー | 必要な 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関連Hook |
※ type は何をトリガーに送信されたか特定するための識別子です
重複排除
Hook v2 ではデータが複数回送信される可能性があります。
そのため、リクエストに含まれる ユニークな id を使用して、重複して送信されたデータでないかのチェックを行うことを推奨します。
各トリガーのリリースステージについて
トリガーのリリースステージは、依存するScopeのリリースステージに応じます。
必要なAPIスコープが beta.xxx.yyyのようにbetaスコープになっているものは、そのAPI同様、トリガー自体も予告なく変更が入る場合などがあります。