Googleフォームの入力内容をもとにして、KARTEで特定のuser idにイベントを発火させる

<html><head></head><body><h2 id="はじめに">はじめに</h2>
こんにちは！髪を剃ってスキンヘッドにしました、どうもCEのUGです！
さて、KARTEには外部とのデータ連携に使用するジョブフローという機能がございます。 
通常、ジョブフローにエラーが発生した際は登録しているメールアドレスに通知をすることがデフォルトで可能です。ただ、SlackやTeamsなどの日々使っているチャットアプリにエラーを通知して欲しいと思ったことはありませんか？ありますよね？
今回のSolution Blogではジョブフローでエラーが発生した際にCraft Functionsを使用してSlackに通知する方法を紹介していきます！
<h2 id="概要">概要</h2>
全体の処理の流れは下記の画像の通りとなります。
Craft側でジョブフローエラーが発生したことを検知して、そのエラー内容を事前に設定しておいたSalckチャネルに対して通知をします。
非常に単純なフローかと思います！
<img src="https://ik.imagekit.io/plaid/2db91d49-0981-4d1d-b747-e934fdc192b0/%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-10-1911.21.47.png" alt="スクリーンショット2023-10-1911.21.47.png">
<h2 id="実装手順">実装手順</h2>
実装の手順は次の通りです。 
大きく分けてSlack 側と KARTE 側のそれぞれの設定があります。
Slack側の設定に関しては<a href="https://solution.plaid.co.jp/202307-hookv2-slack-integration">このSolution Blog</a>も参考に出来るので、是非見てみてください！
<ol>
<li>Slack アプリを作成する</li>
<li>Slack アプリをチャンネルに追加する</li>
<li>API v2 アプリを作成する</li>
<li>Slack アプリの OAuth トークンを Craft Secret Manager に登録する</li>
<li>ファンクションを作成する</li>
<li>Craft Hook v2 トリガーを設定する</li>
</ol>
順番に手順を確認していきます！
<h2 id="1. Slack アプリを作成する">1. Slack アプリを作成する</h2>
まず、Slack チャンネルに通知をするための Slack アプリを作成します。
<ul>
<li><a href="https://api.slack.com/apps" target="_blank" rel="noreferrer"> [slack api &gt; Your Apps] </a> から <code>Create New App</code> をクリック</li>
<li>Create an appの画面で <code>From scratch</code> を選択</li>
<li>次の画面で slack app 名と、slack app を適用する slack workspace を指定</li>
</ul>
アプリの作成が完了したら、Slack アプリ に必要なスコープの設定とOAuth トークンを取得します。
スコープの設定
<ul>
<li>作成したアプリを選択して、[Features &gt; OAuth &amp; Permissions]をクリック</li>
<li>ページ内の Scopes の項目の Bot Token Scopes の <code>Add an OAuth Scope</code> をクリック</li>
<li>プルダウンメニューから <code>chat:write</code> を選択 
<img src="https://ik.imagekit.io/plaid/2de46e75-afc9-4d6f-92a5-444e6a1aa71e/%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-07-1812.57.49.png" alt="スクリーンショット2023-07-1812.57.49.png"></li>
</ul>
OAuth トークンの取得
<ul>
<li>OAuth &amp; Permissions ページ内の OAuth Tokens for Your Workspace の <code>Install to Workspace</code> をクリック</li>
<li>アプリがワークスペースにアクセスするための権限を許可するために、<code>許可する</code> をクリック</li>
<li>自動的に生成される OAuth トークン（Bot User OAuth Token）を控えておく 
<img src="https://ik.imagekit.io/plaid/0696d92f-ec7b-4c5d-9327-cddfbc143039/%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-07-1813.01.11.png" alt="スクリーンショット2023-07-1813.01.11.png"></li>
</ul>
<h2 id="2. Slack アプリをチャンネルに追加する">2. Slack アプリをチャンネルに追加する</h2>
作成した Slack アプリを発言させるためには、通知を飛ばしたいチャンネルに追加する必要があります。
<ul>
<li>通知を飛ばしたいチャンネルの詳細ページを表示</li>
<li>[インテグレーション &gt; App]の <code>アプリを追加する</code> をクリック</li>
<li>今回作成したアプリを追加 
<img src="https://ik.imagekit.io/plaid/c7a4a606-d266-4b12-b647-aae1f1372fe4/%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-07-1813.04.32.png" alt="スクリーンショット2023-07-1813.04.32.png"></li>
</ul>
また、通知を飛ばす Slack チャンネルのチャンネルIDは後で使うため控えておいて下さい。 
ここまでがSlack側の設定となります。次からKARTE側の設定になります。
<h2 id="3. API v2 アプリを作成する">3. API v2 アプリを作成する</h2>
Campaign Change Enabled Hook を利用するためのAPI v2アプリを作成します。 
<img src="https://ik.imagekit.io/plaid/12dde6c4-9a9e-4e80-9612-58f6729897c0/%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-10-1911.45.12.png" alt="スクリーンショット2023-10-1911.45.12.png">
<ul>
<li>[ストア &gt; API v2設定] からアプリを新規作成</li>
<li>[アプリタイプ] を <code>token</code> に設定</li>
<li>必要なscopeを追加
<ul>
<li><code>datahub.jobflow.get</code>: ジョブフローのエラー検知に必要</li>
</ul>
</li>
</ul>
「アプリタイプ」は後から変更できないため、誤って作成した場合は、アプリを再度作成し直してください。
<h2 id="4. Slack アプリの OAuth トークンを Craft Secret Manager に登録する">4. Slack アプリの OAuth トークンを Craft Secret Manager に登録する</h2>
Slack アプリの OAuth トークンを Craft Secret Manager のシークレットとして登録します。それにより、秘匿すべきアクセストークンをファンクション上に直接記述する必要がなくなります。
<img src="https://ik.imagekit.io/plaid/7dfbbd31-7bbe-4b81-9003-b4df79c21995/%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-07-1722.43.07.png" alt="スクリーンショット2023-07-1722.43.07.png">
<ul>
<li>[Craft &gt; シークレット] からシークレットを新規作成</li>
<li>控えておいた OAuth トークンを貼り付けて、適当な名前を付けて保存</li>
</ul>
作成したシークレットの名前は、次に作成するファンクションの中に記載します。
<h2 id="5. ファンクションを作成する">5. ファンクションを作成する</h2>
Slackに通知を飛ばすためのファンクションを作成します。 
<a href="https://github.com/plaidev/craft-codes/blob/main/craft-functions/jobflow-error-notification-to-slack/index.js" target="_blank" rel="noreferrer">サンプルとなるソースコード</a>は、GitHubで公開しています。
作成する際に変数タブで下記の変数の値を設定してください。
<ul>
<li><code>KARTE_PROJECT_ID</code>
<ul>
<li><code>KARTE_PROJECT_ID</code>は KARTE の管理画面URLの project= 以降の部分 
https://admin.karte.io/craft/functions?project=<code>XXXXXXXXXXXXXXXX</code> 
※上記はファンクション一覧ページのURLを例としています</li>
</ul>
</li>
<li><code>SLACK_CHANNEL_ID</code>
<ul>
<li>控えておいたSlack チャンネルID</li>
</ul>
</li>
<li><code>SLACK_TOKEN_SECRET</code>
<ul>
<li>事前に作成したCraft Secret Manager に登録した名前</li>
</ul>
</li>
</ul>
以下でスクリプトの内容を簡潔に説明します！
<ul>
<li>Slackに通知するためのジョブフローの名前、id、ステータスを取得する</li>
</ul>
<pre><code class="hljs"> const jobflow_name = data.jsonPayload.data.name;
 const jobflow_id = data.jsonPayload.data.id;
 const status = data.jsonPayload.data.status;
</code></pre>
<ul>
<li>ジョブフローのステータスがエラーではなかった場合、何もしない</li>
</ul>
<pre><code class="hljs"> if (status !== 'ERROR') {
 return;
 }
</code></pre>
<ul>
<li>Slackに通知するメッセージを定義する</li>
</ul>
<pre><code class="hljs"> let msg = `ジョブフローでエラーが発生しました\n`;
 msg += `ジョブフロー名：${jobflow_name}\n`;
 msg += `ジョブフローURL： https://admin.karte.io/datahub/jobflow/each/${jobflow_id}?project=${KARTE_PROJECT_ID}`;
</code></pre>
<h2 id="6. Craft Hook v2 トリガーを設定する">6. Craft Hook v2 トリガーを設定する</h2>
最後にジョブフローが実行される度にファンクションが実行されるように Hook v2 の設定をします。 Hook v2 の設定は API v2 アプリ上で行います。 
下記の画像を参考にHook v2の設定を行なってください。
<img src="https://ik.imagekit.io/plaid/c620a0ec-0922-4af4-8794-5320e7308a42/%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-10-1912.14.25.png" alt="スクリーンショット2023-10-1912.14.25.png">
<ul>
<li>「2. API v2 アプリを作成する」で作成したアプリの設定画面を開く</li>
<li>[トリガー設定] に <code>KARTE Datahub: ジョブフローの終了時</code> を指定</li>
<li>[チャネル設定 &gt; Craft] を有効化し、先ほど作成したファンクション名を入力</li>
</ul>
これで、ジョブフローが実行時に先ほど作成したファンクションが実行され、Slackに通知が飛ぶ設定が完了しました。
<img src="https://ik.imagekit.io/plaid/349118de-1bb0-4cd9-ae59-31bd73308310/%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-1411.30.25.png" alt="スクリーンショット2023-12-1411.30.25.png">
<h2 id="終わりに">終わりに</h2>
これでジョブフロー実行がエラーで終了した場合に特定のSlackチャネルに通知が飛ぶようになりました！
今回の記事ではSlackに通知をしましたが、SlackではなくTeams等の普段お使いのチャットアプリにも連携が可能ですし、ジョブフローのエラー検知をトリガーに全く別のファンクションを実行することも可能です。是非色々試してみてください！
<hr>
プレイドでは、世の中にインパクトを与える新しいソリューションを一緒につくる仲間を募集しています！ 
ぜひ気軽にお問い合わせください。
↓ パートナー企業になりたい
<ul>
<li><a href="https://ecosystem.plaid.co.jp/" target="_blank" rel="noreferrer">CustomerData-Driven Solution を一緒に創りませんか？ | PLAID Ecosystem</a></li>
</ul>
↓ PLAIDで働きたい
<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>

Datahubジョブフローでエラーが発生した際にSlackにエラー発生したジョブフローを通知するためのファンクションです。

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