KARTE 内の変更を外部アプリケーションに送る

KARTE 内で特定の変更が発生したときに、その情報を外部のサービスなどに転送することができます。

アプリ作成時に作成したアプリの「hook設定」から Webhook の設定などが行なえます。
hook設定をおこなうことによって KARTE 内で特定の変更が発生したときに、その情報を外部のサービスなどに転送することができます。転送することができる「KARTE 内の特定の変更」については、後述の「トリガー設定」をご確認ください。

設定方法

hook 設定をしたいアプリの「hook設定」のタブにて「編集」からボタンをクリックして、各項目の設定を行ってください。
設定する項目については以下のとおりです。

トリガー設定

Webhookのトリガーを指定ができます。トリガーは複数設定することが可能です。
現在指定できるトリガーは以下の通りです。

トリガー

Required Scope

説明

オペレータのアサイン時

talk.assignee.get

KARTE Talk で担当者を変更した場合に発火。

ユーザーからのメッセージ送信時

talk.message.get

KARTE Talk でユーザーからのメッセージを受信したときに発火。※1

オペレーターからのメッセージ送信時

talk.message.get

KARTE Talk で担当者からのメッセージを受信したときに発火。※1

トリガーによって必要な Scope があります。設定したいトリガーに合わせて、アプリの Scope 設定を行ってください。
※1: API から送信されたメッセージは hook されません。

チャンネル設定

各チャンネルの詳細設定です。Webhookの場合であれば、どの URL に転送するかを設定できます。
チャンネルごとに設定項目が変わります。各チャンネルの設定については下記をご参照ください。

Webhook チャンネル

トリガーで指定したイベントが発生したときに、設定されたURLにイベントの情報を送信します。

設定項目

説明

hook status

hook の有効状態。
hook を有効にしたい場合はチェックをし、hook を一時的に停止したい場合はチェックを外してください。

URL

webhook する先のURL

Amazon EventBridge チャンネル(Beta機能)

🚧

こちらの機能はリリース前のβ機能となります

導入を検討されているお客様は営業担当までお問い合わせください。
また、今後予告なく仕様変更を伴う機能改善が行なわれる可能性があります。ご了承ください。

Amazon の AWS が提供する Amazon EventBridge をご利用いただくことで、KARTE で発生したイベントの情報を AWS のサービスで利用することが可能となります。

設定項目

説明

hook status

hookの有効状態。
hook を有効にしたい場合はチェックをし、hook を一時的に停止したい場合はチェックを外してください。

Amazon EventBridge をご利用いただくには追加で「AWSの連携設定」が必要となります。「hook status」 を有効にしていただいた上で、hook設定の「AWSとの連携設定はこちら」から設定画面を開きます。

AWS との連携設定

AWSに連携設定は以下の項目の設定が必要となります。

  • AmazonEventBridgeとの連携を有効化
  • AWS accountID
    • 連携先AWSアカウントのアカウントIDを入力します
  • Region
    • 連携先のregionを選択します

Amazon EventBridge の設定方法

Amazon EventBridge をご利用いただくには AWS 側の設定も必要となります。
AWS 側の設定については KARTE が提供している「Partner event sources」をご確認ください。

Partner event sources は AWSのコンソール より以下の経路でアクセスしてください。
AWS > Amazon EventBridge > Events > Partner event sources > karte.io


What’s Next