メインコンテンツにスキップ

Workflows と Inbox のためのデータコネクタの設定方法

データコネクタを使って、ライブの外部データを Intercom Inbox と Workflows に接続する方法を学びましょう。

対応者:Beth-Ann Sher

データコネクタはノーコードで深く組み込まれた統合機能で、ライブの外部データを Intercom に接続できます。このライブデータは Fin、Workflows、Inbox を動かし、顧客が自動的に自己解決できるようにします。

始めるには、チームメイトがかなりの時間を費やして回答している、現在 Intercom で利用できない情報を使ったよくある質問を考えるのが良い方法です。

これらは、顧客が外部システムに保存されている情報を単に知りたい場合の質問、例えば「注文状況は?」や、外部システムで「配達の再スケジュール」や「返金処理」といったデータコネクタの利用例です。

解決したい質問がわかれば、ほとんど技術的な知識がなくても、データコネクタの設定は驚くほど簡単で迅速です。


データコネクタの作成

まず、設定 > 統合 > データコネクタ に移動します。

ここで、ユースケースに応じて外部データ(例:Shopify、Salesforce など)へのさまざまな接続を設定します。+ 新規 をクリックしてください。

ヒント: Fin 用のデータコネクタ を使うことも可能です。

名前と説明

データコネクタに、どのデータコネクタを使うかを正確に説明するユニークな名前を付けてください(例:「注文IDを取得」)。説明欄には、チームメイトがいつこのデータコネクタを使うべきか、どんな情報が取得できるかを記入します(例:「指定されたIDの注文を取得。注文IDは Conversation CDA に保存されている必要があります」)。

Fin がこのコネクタを直接使えるようにするには、Fin タブに移動し、Fin はこのコネクタをどのように使いますか? を 有効(直接トリガー) に設定します。Workflow、Task、Procedure、Macro 内だけで使いたい場合は、無効(手動トリガー) に設定してください。

API 接続

次にリクエストの詳細を入力します。ここで接続するサードパーティシステムの HTTPS URL(例:Shopify、Salesforce など)を入力する必要があります。

API リクエスト

このリクエストで使うデータコネクタを、メソッドを選択して指定できます。

  • GET - サードパーティシステムから情報を読み取り保存します。

  • POST - サードパーティシステムに情報を作成または追加します。

  • PUT - サードパーティシステムの情報を更新します。

  • DELETE - サードパーティシステムから情報を削除します。

  • PATCH - サードパーティシステムの情報を更新します。

この例では、API から注文IDを GET するリクエストを行い、URL を入力します。

リクエストを行うには、URL は HTTPS アドレスでなければなりません。

ヒント:

  • URL や POST、PUT メソッドのリクエストボディには、User、Conversation、Company、イベントの属性をテンプレート値として挿入できます。すでにワークスペースで設定したカスタムデータ属性を使うか、より柔軟なデータ管理にはカスタムオブジェクトの利用を試してください。

  • データコネクタは XML レスポンスを自動的に JSON に変換します。API が XML を返す場合でも、通常通りエンドポイントを入力すれば Intercom が変換し、テストレスポンスステップで JSON を表示します。その後、ネイティブの JSON API と同様にデータをマッピングして使用できます。

HTTP ヘッダー

リクエストに追加パラメータを加えたい場合は、キーと値のペアを追加をクリックし、HTTP ヘッダーの下でキーと値のペアを選択してください。

認証

データコネクタは固定トークンと動的トークンの両方を認証に対応しています。HTTP ヘッダーの下で、リクエストに使う認証トークンを選択すると、ヘッダーに追加されます。

注意:1つのデータコネクタに複数のトークンを添付できます。各トークンは異なるヘッダーキーで設定してください。すべてのトークンがリクエストと共に送信されます。

リクエストボディ

POST または PUT リクエストの場合、リクエストボディに送信したいデータを含めるオプションがあります。

API によって必要な HTTP ヘッダー(例:accept: application/json や Content-Type: application/json)を必ず含めてください。JSON ボディを送る場合は、Content-Type: application/json を明示的に追加する必要があります。これがないと API はリクエストボディを解析せず、JSON が正しくてもすべてのフィールドを無効と判断します。

レスポンステスト

次に、このデータコネクタが接続先のサードパーティシステムから正しいデータを取得しているかテストします。

重要: このリクエストのテストは API と接続を行い、作成したデータコネクタを完成させます。例えば、DELETE リクエストを行うとデータが削除されます。情報を読み取るだけの GET リクエストでテストすることをお勧めします。

テストリクエスト をクリックして、データコネクタが正しく設定されているか確認してください。接続が API で検証されると緑のチェックマークが表示され、リクエストの詳細が見えます。

これで、Workflows を活用し、顧客に迅速な回答を提供するための情報が揃いました。例えば注文状況などです。

ヒント: データコネクタは XML レスポンスを自動的に JSON に変換します。API が XML を返す場合でも、通常通りエンドポイントを入力すれば Intercom が変換し、テストレスポンスステップで JSON を表示します。その後、ネイティブの JSON API と同様にデータをマッピングして使用できます。

データ変換

デフォルトでは、Fin は返信を生成するためにレスポンス全体のデータにアクセスできます。Fin にアクセスを制限したい場合は、手動でアクセス制限を選択し、Fin にアクセスを許可するデータフィールドをチェックしてください。

レスポンスデータの個々の項目は、編集アイコンをクリックして、顧客向けの名前を付けたり、データの変換を指定したりできます。

例えば、API レスポンスが残高0を返した場合、Fin は未払い残高が0であると答える代わりに、現在未払い残高がないと返答できます。

コードを使ってレスポンスをフィルターまたは変換する

データコネクタのコードブロックを使うことで、Python を使って API レスポンスを直接変換・操作できるようになりました。コネクタ設定内で行えます。

オブジェクトマッピング

このステップは任意です。データコネクタがこの情報を Intercom のどこに保存するかを指定し、Workflows で顧客の質問への回答として提供できるようにします。

データを保存しなくてもよい一般的なケースは、PUT、POST、DELETE のデータコネクタリクエストタイプです。GET リクエストでボットにデータを使いたい場合は、Intercom にデータを保存する必要があります。

Fin用のデータコネクタを作成する際、レスポンスデータをIntercomの属性やオブジェクトにマッピングする必要はありません。代わりに、FinはJSONレスポンスを直接解釈し、それを使って質問を解決できます。レスポンスは「Test response」セクションに基づいて生成されます。各行項目はJSONレスポンス内のデータポイントに対応しています。

JSONレスポンスデータは以下に保存できます:

Intercomオブジェクトを選択し、外部APIオブジェクトとマッピングします。

すべてのカスタム属性およびカスタムオブジェクトは、ここでレスポンス保存に使用する前に作成されている必要があります。

次に、Intercom内でこの情報を保存したいデータ属性を選択します。例えば、Intercomオブジェクトとして「Order」を選択し、外部システムのAPIオブジェクトとして「root」を選択し、API属性「currency」とマッピングしました。

外部データはカスタムデータ属性にのみ保存でき、標準のIntercomデータ属性には保存できません。

レスポンスデータをカスタムオブジェクトにマッピングする

カスタムオブジェクトにマッピングする際は、IDをexternal_idフィールドにマッピングする必要があります。そうしないと、GETリクエストごとに重複が作成されます。カスタムオブジェクトの正しい参照設定について詳しくはこちら。

PeopleまたはConversationからの参照を更新する

次のステップは、更新したいカスタムオブジェクトに関連するPeopleまたはConversationからの参照を選択することです。

ライブ設定

Data connectorのテストが成功したら、ライブ設定の準備が整います。

注意:Data connectorsはドラフト/ライブのバージョニングシステムを使用しています。FinタブのFinトリガー設定を含む変更はドラフトとして保存され、Set liveをクリックするまでライブコネクタには影響しません。変更後にコネクタの動作がおかしい場合は、更新バージョンがライブ設定されているか確認してください。設定のコネクタリストには各コネクタの現在の状態(ライブまたはドラフト)が表示されます。

Data connectorsのタイムアウトは30秒で、顧客が設定変更できません。

ヒント:Data Connectorsの成功率や失敗率をよりリアルタイムで把握したい場合は、Data Connector Execution Webhookを利用できます。これにより、外部サービスでリアルタイムのダッシュボード、アラート、SLA監視のための実行イベントを受け取ることが可能です。


Data connectorの依存関係の表示

Data connectorsを大規模に安全に管理または編集するために、各Data ConnectorやMCPアクションがIntercom内のどこで使用されているかを事前に監査できます。

「Used by」ビューの有効化方法:

Used by列はデフォルトで非表示の場合があります。表示するには:

  1. テーブル右上のメニュー(三本線)をクリックします。

  2. Used byの横のチェックボックスをオンにします。

この列はライブでクリック可能な参照リストを提供します。任意の項目をクリックするとそのソースに直接移動します。

Data connectorの使用状況を以下で追跡します:

  • Workflows

  • Procedures & Tasks

  • Custom Answers

  • Macros


Data connectorのヘルスモニタリング

Data connectorがライブになったら、設定 > インテグレーション > Data connectorsから直接パフォーマンスを監視できます。

ヘルスステータスインジケーター

Health列は、最近の実行成功率とレイテンシに基づいて各コネクタの稼働状況を表示します。

ステータス

基準

意味

正常

成功率が95%以上でレイテンシが通常範囲内。

最適に稼働中。

劣化

成功率が80〜95%の間、またはレイテンシが過去の基準の2倍。

問題が発生しているが部分的に機能している。

不健康

成功率が80%以下。

即時対応が必要な重大な問題。

任意のヘルスステータスバッジにカーソルを合わせると、最近のパフォーマンスの詳細な内訳が表示されます:

フィールド名

説明

成功率

分析対象の合計に対する成功した実行の割合。

外部レイテンシ

外部API/サービスの応答時間(p90、p50、平均、最小、最大、単位はms)。

注:成功した実行のみが含まれます。

内部レイテンシ

内部処理のオーバーヘッド(データコネクタを実行するためのIntercomのシステム内での時間)(p90、p50、平均、最小、最大、単位はms)。

Intercomレイテンシ

合計実行時間。外部レイテンシ+内部レイテンシとして計算される(p90、p50、平均、最小、最大、単位はms)。

HTTPステータス分布

外部サービスから返されたHTTPステータスコードの分布(例:200、500、タイムアウト)と件数および割合。実行が存在しない場合はnullを返します。

失敗タイプの分布

失敗タイプの内訳(例:「Connection Timeout」、「Authentication Failed」)、頻度順に並べ、件数と割合を表示。失敗が発生しなかった場合はnullを返します。

実行回数

現在の期間に分析された実際の実行回数。

時間経過によるHTTPステータス

ヘルスダッシュボードには、選択した期間内に外部APIから返されたHTTPステータスコードの推移を示す積み上げチャートが含まれています。チャートの各帯はステータスクラスを表します:

  • 2xx — 成功した応答

  • 3xx — リダイレクト

  • 4xx — クライアントエラー(例:認証失敗、不正なリクエスト)

  • 5xx — サーバーエラー

  • 応答なし — タイムアウトまたは応答がなかったリクエスト

チャートの上には、選択した期間のリクエスト総数と全体のエラー率を示す要約行があります。チャートは実行レイテンシチャートと時間軸を共有しているため、エラーコードの急増と応答時間の変化を関連付けて確認できます。

時間フィルター

ダッシュボード上部の時間フィルターを使ってレポート期間を調整します。利用可能なオプション:1h、6h、24h、7d、または14d。

ログ

任意のコネクタをクリックして専用のヘルスダッシュボードを開き、Logsタブを選択すると、すべての実行のタイムスタンプ付き記録が表示されます。各エントリには実行されたチャネルと成功・失敗の状態が示されており、任意のエントリをクリックすると実行の詳細が展開されます。

ログは以下でフィルターできます:

  • 実行ID

  • 会話

  • ステータス(成功または失敗)

  • 失敗タイプ

注:ログは最大14日間保持されます。7日間の短縮を希望する場合はサポートチームにお問い合わせください。ダッシュボードを超えた実行データのプログラムアクセスについては、API access to execution resultsを参照してください。


データコネクタをドラフトに移動する

不要になった古いデータコネクタを廃止したい場合は、ドラフト状態に移動できます。

設定 > インテグレーション > データコネクタに移動し、ドラフトに移動したいデータコネクタをクリックしてからドラフトに設定を選択します。

Intercomは依存関係がアクティブなコネクタのドラフト化をブロックしますが、Used by列を使ってこれらを事前に管理できます。この列は、アクションを参照するすべてのWorkflow、Procedure、Task、Macro、Custom Answerのライブインデックスリストを提供します。このリストの任意の項目をクリックすると、その特定の自動化にジャンプして依存関係を解決できます。

注:一時停止状態のProcedureもアクティブな依存関係としてカウントされます。すべての参照Procedureがライブではなく一時停止中であっても、コネクタをドラフトに移動することはブロックされます。ドラフトに設定する前に、一時停止中のProcedureを含むすべてのコネクタ参照を解決してください。

こちらの回答で解決しましたか?