KARTE Datahubのジョブフローエラー発生時にSlack通知する

<html><head></head><body><p>こんにちは、Customer Engineerのgamiです！最近ノンフライヤーを買って揚げ物を揚げまくっています。</p>
<p>さて、KARTEにはLINEと連携する機能があります。特に、LINE公式アカウントと対応するMessaging APIチャネルのWebhook URLにKARTE側エンドポイントを登録することで、友だち追加やメッセージ送信などのLINE側のユーザー行動をKARTE側にリアルタイム連携することができます。</p>
<p>一方で、 <strong>LINE Messaging APIチャネルのWebhook URLには「複数URLを登録できない」という仕様があり、これが問題になるケースがあります</strong> 。具体的には、KARTE以外にLINE公式アカウントのWebhookを連携したい外部サービスを利用している場合、LINEのWebhook URLにKARTEのエンドポイントを登録してしまうと、もう一つの外部サービスにLINEのWebhookを送れなくなってしまうという問題です。</p>
<p>実はこの問題は、 <a href="https://craft.developers.karte.io/craft-functions/triggers/line-hook" target="_blank" rel="noreferrer">Craft LINE Hook</a> というトリガーを利用してCraft Functionsを起動することで、解消することができます。</p>
<p>今回は、KARTE CraftでLINEのMessaging API WebhookをKARTE以外の別サービスに分岐させる方法について紹介します。</p>
<h1 id="想定する状況">想定する状況</h1>
<p>この記事では、次のような状況を想定してます。</p>
<ul>
<li>LINE公式アカウントを運用している</li>
<li>それに紐付くMessaging APIチャネルのWebhook URLには、KARTE以外の外部サービスのエンドポイントが登録されている</li>
<li>その外部サービスとLINEとの連携を維持したまま、LINE Webhookを新たにKARTEにも連携させたい</li>
<li>KARTEプロジェクト側で、KARTEのLINE連携オプションがすでに有効になっている
<ul>
<li>詳細: <a href="https://support.karte.io/post/2Qw6muPU7a5PSKV0M8ler0" target="_blank" rel="noreferrer">LINE連携 - 概要 | ドキュメント / 接客タイプ / LINE | KARTEサポートサイト</a></li>
</ul>
</li>
</ul>
<h1 id="アウトプットイメージ">アウトプットイメージ</h1>
<p>構成図は次の通りです。</p>
<p><img src="https://ik.imagekit.io/plaid/525e0478-5be4-44b0-9a5c-9562bd4990b4/%E3%82%B9%E3%82%AF%E3%83%AA%E3%83%BC%E3%83%B3%E3%82%B7%E3%83%A7%E3%83%83%E3%83%882023-12-1118.31.01.png" alt="スクリーンショット2023-12-1118.31.01.png"></p>
<p>LINE Messaging APIのWebhookを一度KARTE側エンドポイントで受けた上で、それをCraft Functionsを介して外部サービスに連携します。</p>
<h1 id="手順">手順</h1>
<p>設定手順は次の通りです。</p>
<ol>
<li>Craft Functionsを作成する</li>
<li>Craft LINE Hookトリガーを設定する</li>
<li>LINE Messaging APIのWebhook URLをKARTE側エンドポイントに切り替える</li>
</ol>
<p>順番に説明します。</p>
<h2 id="1. Craft Functionsを作成する">1. Craft Functionsを作成する</h2>
<p>まずはLINE Webhookで受け取ったデータを外部サービスに連携するためのCraft FunctionsのFunctionを作成します。サンプルとなるソースコードは、Craft FunctionsのテンプレートとしてGitHubで公開しています。</p>
<p><a href="https://github.com/plaidev/craft-codes/tree/main/craft-functions/line-webhook-branch" target="_blank" rel="noreferrer">craft-codes/craft-functions/line-webhook-branch at main · plaidev/craft-codes</a></p>
<p>作成手順は次の通りです。</p>
<ul>
<li>[Craft &gt; ファンクション &gt; 作成 &gt; テンプレートから作成] を選択</li>
<li><code>KARTE CraftでLINEのMessaging API Webhookを別サービスに分岐する</code> というテンプレートを検索し「取得」ボタンをクリック</li>
<li>「反映」ボタンをクリック</li>
<li>[変数] タブで次の変数の値を設定する
<ul>
<li><code>TARGET_URL</code>: LINEのWebhookを送信したい外部サービスのエンドポイントURL</li>
</ul>
</li>
<li>Functionを有効化して保存</li>
</ul>
<p>変数TARGET_URLの値には、元々LINE Messaging APIチャネルのWebhook URLに登録していたのと同じ外部サービス側URLを指定してください。</p>
<h2 id="2. Craft LINE Hookトリガーを設定する">2. Craft LINE Hookトリガーを設定する</h2>
<p>Craft Functionsが作成できたら、ファンクションをトリガーするためのCraft LINE Hookの設定をします。</p>
<ul>
<li>[Craft &gt; 設定 &gt; LINE Hook 設定] を編集します</li>
<li>次のように設定します
<ul>
<li>[有効化 &gt; 有効にする] にチェック</li>
<li>[起動ファンクション] で作成したファンクションを選択</li>
</ul>
</li>
<li>[保存] します</li>
</ul>
<p><img src="https://ik.imagekit.io/plaid/336156bc-158a-4748-af73-a3fc0a5fa490/%E3%82%B9%E3%82%AF%E3%83%AA%E3%83%BC%E3%83%B3%E3%82%B7%E3%83%A7%E3%83%83%E3%83%882023-12-1118.42.53.png" alt="スクリーンショット2023-12-1118.42.53.png"></p>
<p>これによって、KARTEがLINEからWebhookを受け取る度に、「起動ファンクション」に設定したファンクションが毎回実行されるようになります。ファンクションには、LINE Webhookから受け取ったデータが実行時に渡されます。</p>
<p>Craft LINE HookやそこからCraft Functionsに送信されるデータの詳細については、下記ドキュメントをご覧ください。<br>
<a href="https://craft.developers.karte.io/craft-functions/triggers/line-hook" target="_blank" rel="noreferrer">Craft LINE hook</a></p>
<h2 id="3. LINE Messaging APIのWebhook URLをKARTE側エンドポイントに切り替える">3. LINE Messaging APIのWebhook URLをKARTE側エンドポイントに切り替える</h2>
<p>最後に、LINE Developerの管理画面にログインし、Messaging APIのWebhook URLをKARTE側エンドポイントに切り替えます。</p>
<ul>
<li>LINE Developersにログイン</li>
<li>対象のMessaging APIチャネルの設定を開く</li>
<li>[Messaging API設定] タブの [Webhook設定] にKARTE側エンドポイントURLを設定し、保存する
<ul>
<li>URL形式: <code>https://t.karte.io:443/hook/API_KEY/line/line_message</code>
<ul>
<li>※ API_KEYの部分は、対象KARTEプロジェクトのAPIキーを設定します</li>
</ul>
</li>
</ul>
</li>
</ul>
<p><img src="https://ik.imagekit.io/plaid/07218866-abde-4a12-b21d-96be6f407fe5/%E3%82%B9%E3%82%AF%E3%83%AA%E3%83%BC%E3%83%B3%E3%82%B7%E3%83%A7%E3%83%83%E3%83%882023-12-1214.12.04.png" alt="スクリーンショット2023-12-1214.12.04.png"></p>
<p>なお、すでにKARTE側エンドポイントURLが登録されている場合は変更する必要はありません。</p>
<p>LINE Messaging APIとKARTEの連携設定については下記ドキュメントをご覧ください。<br>
<a href="https://support.karte.io/post/1xH2Z6UG3EVX7hNkJagwgS" target="_blank" rel="noreferrer">LINE連携 - 初期設定 | ドキュメント / 接客タイプ / LINE | KARTEサポートサイト</a></p>
<h1 id="実際に動かしてみる">実際に動かしてみる</h1>
<p>実際に動作を確認してみましょう。</p>
<ul>
<li>KARTE側にLINE Webhook経由のデータが連携されていることを確認する
<ul>
<li>手順例
<ul>
<li>手元のLINEアプリから、当該LINE公式アカウントを友だち追加</li>
<li>当該LINE公式アカウントに対してメッセージ送信</li>
<li>KARTEのイベント画面で、 <code>plugin_line_identify</code> イベントや <code>_line_message</code> イベントが発生していることを確認
<ul>
<li>参考: <a href="https://support.karte.io/post/5MJWz1WC2y2krpincZZhph" target="_blank" rel="noreferrer">LINE関連で発生するイベント | KARTEサポートサイト</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li>外部サービス側でLINE Webhook経由のデータが連携されていることを確認する</li>
</ul>
<p>設定に問題がなければ、当該LINE公式アカウント上でのエンドユーザーの友だち追加やメッセージ送信に関するデータが、KARTEと外部サービスの両方にリアルタイム連携されることが確認できます。</p>
<h1 id="注意点">注意点</h1>
<ul>
<li>LINE Messaging APIのWebhookをすでに外部サービスで利用している場合は、Webhook URLの変更によって当該サービスの挙動に影響が出る可能性があります。影響範囲の確認や動作検証を十分に行った上で、設定変更をしてください</li>
<li>Craft Functionsの仕様上、ごく稀にファンクションが重複実行される可能性があります。重複実行の可能性を許容できない場合は、重複実行を回避するためにファンクションの実装を変更してください
<ul>
<li><a href="https://solution.plaid.co.jp/implementing-exactly-once-semantics-in-karte-craft">KARTE Craftでファンクションの重複実行を防ぐ</a></li>
</ul>
</li>
</ul>
<h1 id="おわりに">おわりに</h1>
<p>LINEはエンドユーザーとの接点を持つ上で非常に魅力的なプラットフォームです。一方で、LINE Messaging APIチャネルの「Webhook URLを複数登録できない」という仕様によって、複数サービスとの同時連携が難しいという課題があります。</p>
<p>この課題がKARTEとLINEとの連携の障壁になる場合は、ぜひ今回紹介したCraft Functionsを使ったLINE Webhookの分岐をご検討ください！</p>
<hr>
<p>プレイドでは、世の中にインパクトを与える新しいソリューションを一緒につくる仲間を募集しています！<br>
ぜひ気軽にお問い合わせください。</p>
<p>↓ パートナー企業になりたい</p>
<ul>
<li><a href="https://ecosystem.plaid.co.jp/" target="_blank" rel="noreferrer">CustomerData-Driven Solution を一緒に創りませんか？ | PLAID Ecosystem</a></li>
</ul>
<p>↓ PLAIDで働きたい</p>
<ul>
<li><a href="https://recruit.plaid.co.jp/requisitions/general-customer-engineer" target="_blank" rel="noreferrer">Customer Engineer | 募集ポジション | 株式会社プレイド</a></li>
<li><a href="https://recruit.plaid.co.jp/requisitions/product-engineer" target="_blank" rel="noreferrer">Product Engineer | 募集ポジション | 株式会社プレイド</a></li>
</ul>
</body></html>

LINE Messaging APIチャネルのWebhook URLには「複数URLを登録できない」という仕様があり、複数サービスと連携できないという問題があります。これを回避するためにKARTE CraftでLINEのMessaging API WebhookをKARTE以外の別サービスに分岐させる方法について紹介します。