glip-integration-js

Framework to create RingCentral notification messaging app

Usage no npm install needed!

<script type="module">
  import glipIntegrationJs from 'https://cdn.skypack.dev/glip-integration-js';
</script>

README

glip-integration-js

Js framework to create RingCentral notification messaging app.

Prerequisites

  • Download and install RingCentral app and login: https://www.ringcentral.com/apps/rc-app
  • Nodejs 8.10+/npm, recommend using nvm to install nodejs/npm.
  • If you want to create RingCentral Glip integration that can show in RingCentral Glip apps list, you need a RingCentral developer account that can create Glip integration: you need sign up and apply for the permission to create Glip integration.

Quick start

Let's start a simple RingCentral Glip integration that post time to a Glip team you selected.

# get the code
git clone git@github.com:ringcentral/glip-integration-js.git
cd glip-integration-js

# install dependecies
npm i

# start proxy server, this will make your local bot server can be accessed by RingCentral service
npm run ngrok

# will show
Forwarding                    https://xxxx.ap.ngrok.io -> localhost:6066
# Remember the https://xxxx.ap.ngrok.io, we will use it later

Goto Glip app's App list, select Webhook app, and choose a team, and copy the glip webhook url for later use, and confirm install.

# create env file
cp .env.sample .env
# then edit .env,
# set https://xxxx.ap.ngrok.io as RINGCENTRAL_APP_SERVER
# set glip webhook url copied as STATIC_WEBHOOK

# run local dev server
npm start

Then the team will get timestamp message every minute.

Check example-configs/interval-send-time.js to see the code, it is pretty simple.

Use it as CLI tool

npx glip-integration-js path-to-your-config.js

Use is as a module

docs/direct-use.md

Real example

docs/write-a-config.md

Write a config

docs/write-a-config.md

Build and Deploy to AWS Lambda

docs/deploy-to-lambda.md

Init a source server project with factory CLI tool

We have built-in CLI command to init a empty project from template: https://github.com/ringcentral/glip-integration-template-js.

npm i -g glip-integration-js
glip-integration-js-create my-app

Links

License

MIT