この記事では、アカウントで新しいレビューを受信するたびにSlack通知を送信するアプリの作成方法について説明します。設定は、Slackアプリの作成、Yextアカウントへのプラグインのアップロード、および両者を接続するYextアプリの作成という3つの手順で構成されます。
必要条件
- アプリを作成する権限を持つSlackワークスペース、またはSlack管理者の承認
- アカウント機能およびDeveloper ConsoleにアクセスできるYextアカウント。
手順1:Slackアプリを作成する
- レビュー通知を表示するSlackチャンネルを作成するか、既存のチャンネルを特定します。
- api.slack.com/appsにアクセスし、[新しいアプリを作成(Create New App)]をクリックします。
- [最初から(From Scratch)]を選択し、アプリ名を入力して、ワークスペースを選択します。
- [機能を追加(Add Features and Functionality)]で、[Incoming Webhook]をクリックします。
- 機能をオンに切り替えてください。
- [新しいWebhookの追加をリクエスト(Request to Add New Webhook)]をクリックし、Webhookの用途を説明するメッセージをSlack管理者に送信します。
- 管理者がリクエストを承認したら、api.slack.com/appsに戻ってください。アプリを選択して、[Incoming Webhooks]に戻ります。
- [ワークスペースに新しいWebhookを追加(Add New Webhook to Workspace)]をクリックし、レビュー通知用のチャンネルを選択して、[許可(Allow)]をクリックします。
- ページ下部のWebhook URLをコピーします。手順2で必要になります。
手順2:Publisherプラグインをアップロードする
- [アカウント設定(Account Settings)] > [アカウント機能(Account Features)]に移動し、[2023年夏の製品リリース:アプリでのサーバーレス関数のトリガー(早期アクセス)(Summer '23: Trigger Serverless Functions in Apps (early access))]を有効にします。[保存(Save)]をクリックします。
- このリンクにアクセスして、アカウントへのSlack関数の適用を開始します。
- 右上隅の[適用(Apply)]をクリックします。
- アカウントIDを入力し、[続行(Continue)]をクリックします。
- 手順1でコピーしたWebhookのURLとアカウントIDを入力します。
- 保存、続行、確認の順にクリックしてください。
アップロードが正常に完了したことを確認するには、[Developer] > [管理者コンソール(Admin Console)]に移動し、platform > plugin > slackReviewsPublisherのパスにファイルが表示されていることを確認します。
手順3:Yextアプリを作成する
- [Developer] > [Developer Console]に移動します。
- [アプリを追加(Add an App)]をクリックし、「Slack Reviews Publisher」などの名前を入力して、[アプリを作成(Create App)]をクリックします。
- [API認証情報(API Credentials)]タブで、[新しいAPI権限を追加(Add a new API Permission)]をクリックします。[管理API(Management API)] > [レビュー(Reviews)]を選択し、[読み取り専用(Read-only)]権限を設定して、[保存(Save)]をクリックします。
- [Webhook]タブで、[Webhookを追加(Add a Webhook)]をクリックします。
- Webhookタイプとして[レビュー(Reviews)]を選択し、[次へ(Next)]をクリックします。
- Webhookの名前(「Slack Review Notification」など)を入力します。
- [URL]で、[関数を呼び出す(Invoke a Function)]をクリックします。[slackReviewsPublisher]を選択し、[handleNotification]の関数を選択します。
- [完了して追加(Finish and Add)]をクリックします。
これで、アカウントで新しいレビューを受信するたびに、Slackチャンネルに通知が送信されます。