Skip to content

Latest commit

 

History

History
111 lines (73 loc) · 4.21 KB

README.md

File metadata and controls

111 lines (73 loc) · 4.21 KB
Raw

Standup Chatbot Zoom Rivet for JavaScript

Use of this sample app is subject to our Terms of Use.

This is a sample app using Zoom Rivet for JavaScript

Installation

Run the following command to clone the repository:

$ git clone https://github.com/zoom/rivet-javascript-sample.git

Setup

  1. Navigate to the repository via command line:
$ cd rivet-sample-app
  1. Install the dependencies:
$ npm install
  1. Create an environment file to store your credentials:
$ touch .env

  1. Obtain your Client Id, Client Secret, and Secret Token from the App Marketplace. You can find the Client Id and Client Secret on the Basic Information, while you can find your Secret Token in the Feature > Access page. If you have not created a Chatbot, follow these steps to create a Chatbot App on the Zoom App Marketplace. Make sure to mark your app as Admin-managed in the Basic Information section while setting up your app!

  2. Enter your Client Id, Client Secret, and Secret Token into your newly created environment file:

CLIENT_ID="CLIENT_ID_HERE"
CLIENT_SECRET="CLIENT_SECRET_HERE"
WEBHOOK_SECRET_TOKEN="SECRET_TOKEN_HERE"

⚠️ Do not store credentials in plain text in production environments

  1. Start your local development server using the following command:
$ node index.js
  1. Now that you have your local server running, we need to use ngrok to expose the two ports and allow Zoom Rivet to listen to the chatbot's webhook events.

Usually ngrok allows forwarding a single port, but if you add the following to your ngrok configuration file, you can serve up both with a single command.

$ ngrok config edit
version: 2
authtoken: [YOUR_AUTH_TOKEN]
tunnels:
chatbot:
    proto: http
    addr: 4001
teamchat:
    proto: http
    addr: 4002

$ ngrok start teamchat chatbot

  1. ngrok will provide two forwarding addresses. Copy port 4001 URL and add it to the Bot Endpoint URL field in the Features -> Surface -> Team Chat Subscriptions section of the App Marketplace page for your chatbot, followed by /zoom/events. Here you can add the slash command standup_bot.

  2. Now it is time to add the relevant Team Chat scopes to ensure your app is allowed to call API methods. You can add scopes via the Scopes section of the App Marketplace page for your chatbot. This sample app requires a minimum of the imchat:bot, and team_chat:read:list_user_channels:admin, team_chat:read:list_members:admin scopes.

Scopes

  1. Finally, you must Authorize by visiting the page provided by Rivet at http://localhost:4002/zoom/oauth/install. See Authorizing with Zoom for more information.

Usage

  1. On your Zoom Team Chat Chatbot App's Credentials section, go to the Local Test or Submit page depending on which envoirnment you are using (Development or Production), and click "Add". After authorizing, go to Zoom Team Chat and see a message from the Standup Chatbot.

  2. In any channel, type the following slash command to see a list of commands available:

/standup_bot help

Help slash command

  1. Use the following slash command to start the standup. The standup bot will automatically list each member of the channel and give them a field to provide their standup for the day.
/standup_bot start

Start slash command

  1. When a channel member edits the standup form field, the standup bot will automatically update the original message and remove the editable property of the field.

Start slash command after submission

Need help?

For more information, follow the Rivet documentation.

If you're looking for help, try Developer Support or our Developer Forum. Priority support is also available with Premier Developer Support plans.