{"id":21406635,"url":"https://github.com/ringcentral/notification-app-js","last_synced_at":"2025-07-14T00:32:40.253Z","repository":{"id":72054121,"uuid":"297896698","full_name":"ringcentral/notification-app-js","owner":"ringcentral","description":"js framework to create notification app for RingCentral","archived":false,"fork":false,"pushed_at":"2022-03-24T03:55:37.000Z","size":387,"stargazers_count":6,"open_issues_count":1,"forks_count":1,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-06-15T11:57:11.237Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ringcentral.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-09-23T08:00:26.000Z","updated_at":"2024-06-12T02:34:57.000Z","dependencies_parsed_at":"2023-03-21T21:04:53.141Z","dependency_job_id":null,"html_url":"https://github.com/ringcentral/notification-app-js","commit_stats":null,"previous_names":["ringcentral/glip-integration-js"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/ringcentral/notification-app-js","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ringcentral%2Fnotification-app-js","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ringcentral%2Fnotification-app-js/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ringcentral%2Fnotification-app-js/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ringcentral%2Fnotification-app-js/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ringcentral","download_url":"https://codeload.github.com/ringcentral/notification-app-js/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ringcentral%2Fnotification-app-js/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265227898,"owners_count":23731059,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-22T16:41:06.267Z","updated_at":"2025-07-14T00:32:40.241Z","avatar_url":"https://github.com/ringcentral.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# JavaScript Notification Framework\n\nJs framework to create RingCentral notification messaging app.\n\n## Prerequisites\n\n- Download and install RingCentral app and login: https://www.ringcentral.com/apps/rc-app\n- Nodejs 8.10+/npm, recommend using [nvm](https://github.com/creationix/nvm) to install nodejs/npm.\n- If you want to create RingCentral Team Messaging integration that can show in RingCentral Team Messaging apps list, you need a RingCentral developer account that can create Team Messaging integration: you need [sign up](https://developers.ringcentral.com/) and apply for the permission to create `Glip` integration.\n\n## Quick Start Step 1 - Understanding Webhooks to Team Messaging\n\nLet's start a simple RingCentral Team Messaging integration that posts the current time to a RingCentral team of your choice.\n\n```bash\n# get the code\ngit clone git@github.com:ringcentral/notification-app-js.git\ncd notification-app-js\n\n# install dependecies\nnpm i\n\n# start proxy server, this will allow your local bot server to be accessed by the RingCentral service\nnpm run ngrok\n\n# will show\nForwarding                    https://xxxx.ap.ngrok.io -\u003e localhost:6066\n# Remember the https://xxxx.ap.ngrok.io, we will use it later\n```\n\nGoto RingCentral app's App list, select the [Incoming WebHooks](https://www.ringcentral.com/apps/glip-webhooks) app, choose a team, and copy the incoming webhook url for later use. Confirm installation.\n\n```bash\n# create env file\ncp .env.sample .env\n# then edit .env,\n# set https://xxxx.ap.ngrok.io as RINGCENTRAL_APP_SERVER\n# set incoming webhook url copied as STATIC_WEBHOOK\n\n# run local dev server\nnpm start\n```\n\nThe team will get a timestamp message every minute.\n\nCheck [example-configs/interval-send-time.js](example-configs/interval-send-time.js) to see the code, it is pretty simple.\n\n## Quick Start Step 2 - Send Adaptive Cards to Team Messaging\n\nNow that you know how to send messages to a team via incoming webhooks, let's send something a little more exciting.\n\n```bash\nnpm run dev1\n```\n\nThis will send an example adaptive card that looks like a GitHub notification. This card will send every 1 minute until you manually stop the running service.\n\nCheck [example-configs/interval-send-time-with-adaptive-card.js](example-configs/interval-send-time-with-adaptive-card.js) to see the code\n\nCheck [https://adaptivecards.io/samples/](https://adaptivecards.io/samples/) for more examples of adaptive cards (Note: some samples may not render yet as we continue to develop all adaptive card elements) or even use the [https://adaptivecards.io/designer/](https://adaptivecards.io/designer/) to create your own!\n\n## Quick Start Step 3 - Create a Configuration Page\n\nIn the quick start step 1 section, the app is quite simple, it only sends a message to the webhook url. What if we have a third party service send a message to the webhook url? For example, a GitHub notification app could auto send GitHub events to RingCentral chat group,\n\nCreating a configuration page to setup your webhook source is more involved.  Follow along in this demo project, with step by step guide in readme:\n\nhttps://github.com/ringcentral/github-notification-app-demo\n\nAdditional guides:\n[ringcentral-notification-app with UI(authorization and else)](https://github.com/ringcentral/ringcentral-notification-demo-ui-app)\n[ringcentral-notification-integration-helper](https://github.com/ringcentral/ringcentral-notification-integration-helper) which is used to communicate with RingCentral App.\n\n## Use it as CLI tool\n\n```bash\nnpx glip-integration-js path-to-your-config.js\n```\n\n## Use it as a module\n\n[docs/direct-use.md](docs/direct-use.md)\n\n## Real example\n\n- [ringcentral-notification-app with UI(authorization and else)](https://github.com/ringcentral/ringcentral-notification-demo-ui-app)\n\n## Write a config\n\n[docs/write-a-config.md](docs/write-a-config.md)\n\n## Build and Deploy to AWS Lambda\n\n[docs/deploy-to-lambda.md](docs/deploy-to-lambda.md)\n\n## Init a source server project with factory CLI tool\n\nWe have built-in CLI command to init a empty project from template: [https://github.com/ringcentral/glip-integration-template-js](https://github.com/ringcentral/glip-integration-template-js).\n\n```bash\nnpm i -g glip-integration-js\nglip-integration-js-create my-app\n```\n\n## Links\n\n- Format messages before send to glip webhook: https://developers.ringcentral.com/guide/team-messaging/manual/formatting\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fringcentral%2Fnotification-app-js","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fringcentral%2Fnotification-app-js","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fringcentral%2Fnotification-app-js/lists"}