https://github.com/grokify/rchooks
Tools to manage RingCentral webhooks including CLI app Keepalive Lambda function
https://github.com/grokify/rchooks
cli-utilities cli-utility glip glip-webhook ringcentral
Last synced: about 2 months ago
JSON representation
Tools to manage RingCentral webhooks including CLI app Keepalive Lambda function
- Host: GitHub
- URL: https://github.com/grokify/rchooks
- Owner: grokify
- License: mit
- Created: 2018-05-19T04:04:58.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2024-04-07T13:19:57.000Z (about 1 year ago)
- Last Synced: 2024-04-07T14:26:43.574Z (about 1 year ago)
- Topics: cli-utilities, cli-utility, glip, glip-webhook, ringcentral
- Language: Go
- Homepage: https://developer.ringcentral.com
- Size: 362 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# RCHooks - RingCentral Webhook Tools
[![Build Status][build-status-svg]][build-status-url]
[![Lint Status][lint-status-svg]][lint-status-url]
[![Go Report Card][goreport-svg]][goreport-url]
[![Docs][docs-godoc-svg]][docs-godoc-url]
[![License][license-svg]][license-url]
[![Video][video-svg]][video-url]
`rchooks` is a toolset for creating, listing, recreating, and deleting RingCentral webhooks. It is especially useful in development when working with ngrok and when webhooks are blocked when test servers are taken down and non-responsive. It includes the following:
* `rchooks` CLI app
* `keepalive_lambda` AWS Lambda function to check and rebuild webhook when blacklisted
* `rchooks` SDK package for utilities to build your own apps
YouTube Tutorial Video: https://youtu.be/DYrzzJe8OyI
## Apps
### CLI App
#### CLI Installation
```
$ go install github.com/grokify/rchooks/cmd/rchooks
$ rchooks --env=/path/to/.env --list
```
Prior to Go 1.18, use `go get`:
```
$ go get github.com/grokify/rchooks/cmd/rchooks
$ rchooks --env=/path/to/.env --list
```
#### CLI Usage
By default, `rchooks` looks for an environment file path specified by the `ENV_PATH` environment variable or a `.env` file in the current working directory. You can also explicitly specify a `.env` file with the `--env` path parameter.
```
$ rchooks --list
$ rchooks --create=https://example.com/webhook
$ rchooks --recreate=https://example.com/webhook
$ rchooks --recreate=11112222-3333-4444-5555-66667777888
$ rchooks --delete=https://example.com/webhook
$ rchooks --delete=11112222-3333-4444-5555-66667777888
```
Configure OAuth by setting the `oauth2more/credentials` file via `--creds` and the account via `--account`.
Set the following enviroment variables:
* `RINGCENTRAL_WEBHOOK_DEFINITION_JSON` - Create subscription JSON body
##### Example Webhook Definition
An example value for `RINGCENTRAL_WEBHOOK_DEFINITION_JSON` can be the following. For a long lived webhook, use a value like `500000000` seconds which is equivalent to 15.85 years.
```
{
"eventFilters":[
"/restapi/v1.0/glip/posts",
"/restapi/v1.0/glip/groups",
"/restapi/v1.0/account/~/extension/~/message-store/instant?type=SMS"
],
"deliveryMode":{
"transportType":"WebHook",
"address":"https://12345678.execute-api.us-east-1.amazonaws.com/prod/webhook"
},
"expiresIn":500000000
}
```
Compact example:
`{"eventFilters":["/restapi/v1.0/glip/posts","/restapi/v1.0/glip/groups","/restapi/v1.0/account/~/extension/~/message-store/instant?type=SMS"],"deliveryMode":{"transportType":"WebHook","address":"https://12345678.execute-api.us-east-1.amazonaws.com/prod/webhook"},"expiresIn":500000000}`
### Keepalive Lambda Function
#### Installation
Build the lambda function and then upload to AWS:
```
$ go get github.com/grokify/rchooks
$ cd $GOPATH/src/github.com/grokify/rchooks/apps/keepalive_lambda
$ sh build_lambda.sh
```
Set the following enviroment variables:
* `RINGCENTRAL_TOKEN` - JSON string or simple access token string
* `RINGCENTRAL_SERVER_URL`
* `RINGCENTRAL_WEBHOOK_DEFINITION_JSON` - Create subscription JSON body
## Notes
### Blacklist Reasons
* `I/O operation is failed. Details: [Read timed out]`
* `Webhook response exceeds max size. Read bytes count: [1024]`
* `Webhook responses with code: [404], reason: [Not Found]`
[build-status-svg]: https://github.com/grokify/rchooks/workflows/test/badge.svg
[build-status-url]: https://github.com/grokify/rchooks/actions/workflows/test.yaml
[lint-status-svg]: https://github.com/grokify/rchooks/workflows/lint/badge.svg
[lint-status-url]: https://github.com/grokify/rchooks/actions/workflows/lint.yaml
[goreport-svg]: https://goreportcard.com/badge/github.com/grokify/rchooks
[goreport-url]: https://goreportcard.com/report/github.com/grokify/rchooks
[docs-godoc-svg]: https://pkg.go.dev/badge/github.com/grokify/rchooks
[docs-godoc-url]: https://pkg.go.dev/github.com/grokify/rchooks
[license-svg]: https://img.shields.io/badge/license-MIT-blue.svg
[license-url]: https://github.com/grokify/rchooks/blob/master/LICENSE
[video-svg]: https://img.shields.io/badge/tutorial-YouTube-blue.svg
[video-url]: https://youtu.be/DYrzzJe8OyI