https://github.com/ringcentral/bugsnag-notification-app
Bugsnag notification and bot add-in for RingCentral app
https://github.com/ringcentral/bugsnag-notification-app
add-ins bot bugsnag ringcentral serverless
Last synced: 6 months ago
JSON representation
Bugsnag notification and bot add-in for RingCentral app
- Host: GitHub
- URL: https://github.com/ringcentral/bugsnag-notification-app
- Owner: ringcentral
- License: mit
- Created: 2020-12-18T09:19:26.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-23T03:19:37.000Z (8 months ago)
- Last Synced: 2024-10-24T22:17:20.942Z (7 months ago)
- Topics: add-ins, bot, bugsnag, ringcentral, serverless
- Language: JavaScript
- Homepage: https://www.ringcentral.com/apps/bugsnag
- Size: 2 MB
- Stars: 2
- Watchers: 7
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Bugsnag Add-in
[](https://github.com/ringcentral/bugsnag-notification-app/actions)
[](https://coveralls.io/github/ringcentral/bugsnag-notification-app?branch=main)
[Bugsnag notification add-in](https://www.ringcentral.com/apps/bugsnag) and bot for [RingCentral app](app.ringcentral.com).
## Development
### 1. Clone this project
```
$ git clone https://github.com/ringcentral/bugsnag-notification-app.git
```
### 2. Install dependencies
Inside project root:
```
$ npm install
```
### 3. Start Ngrok to create a URI for public internet access
```
$ npm run ngrok
```
Keep this process active, and you will get a publish uri as `https://xxxxxxxxxx.ngrok.io` that connected with your local port `localhost:6066`.
### 4. Create a free RingCentral Notifications app
Please follow [here](https://developers.ringcentral.com/guide/team-messaging/add-ins/creation) to create a RingCentral notification app.
In `App Features`, enable `Interactive Messages`, then input URI `https://xxxxxx.ngrok.io/interactive-messages`. Please replace with your ngrok domain.
In `Integrated installation in RingCentral app` section, enable `This app can be installed via the web`, then input URI `https://xxxxxx.ngrok.io/webhook/new`.
### 5. Create a free RingCentral Bots app
Please follow [here](https://developers.ringcentral.com/guide/team-messaging/add-ins/creation) to create a RingCentral Bots app.
In `App Permissions` section, add `Read Accounts`, `Team Messaging` and `Webhook Subscriptions`.
In `OAuth Redirect URI` section, input `https://xxxxxx.ngrok.io/bot/oauth`. Please replace with your ngrok domain.
In `App Features`, enable `Interactive Messages`, then input URI `https://xxxxxx.ngrok.io/interactive-messages`. Please replace with your ngrok domain.
### 6. Create `.env` file
```
$ cp .env.default .env
```
Edit `.env` file as `.env.default` to set environment variables.
The `APP_SERVER` is publish uri that we get from ngrok.
For `DATABASE_CONNECTION_URI`, we can just keep `sqlite://./db.sqlite`. We will use sqlite as local database.
### 7. Setup Database
We will use sqlite as local database. Please install sqlite3 in your machine firstly.
Init Database:
```
$ npm run initDB
```
### 8. Start server
```
$ npm start
```
### 9. Test at RingCentral sandbox
Go to `https://app.devtest.ringcentral.com/apps/sandbox` with your sandbox account, you can get your apps in development here. Click Plus icon to add your notification app or bots to test.
## Deploy with serverless
### 1. Create `serverless-deploy/env.yml` file
```
$ cp serverless-deploy/env.default.yml serverless-deploy/env.yml
```
Edit `serverless-deploy/env.yml` to set environment variables.
We will get `APP_SERVER` after first deploy. So now just keep it blank.
### 2. Create `serverless-deploy/serverless.yml` file
```
$ cp serverless-deploy/serverless.default.yml serverless-deploy/serverless.yml
```
Edit `serverless-deploy/env.yml` to update serverless settings.
The Dynamo `TableName` should be `${DYNAMODB_TABLE_PREFIX}webhooks`. DYNAMODB_TABLE_PREFIX is environment variable that we set upper.
### 3. Deploy
```
$ npm run serverless-build
$ npm run serverless-deploy
```
In first deploy, you will get lambda uri in console output: `https://xxxxxx.execute-api.us-east-1.amazonaws.com/prod`.
Copy the uri, and update environment variable `APP_SERVER` with it in `serverless-deploy/env.yml` file. Then deploy again:
```
$ npm run serverless-deploy
```
Then update app settings in [RingCentral developer portal](https://developers.ringcentral.com/), with your new `APP_SERVER`.