Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bluetel/chatops-webhook-proxy
A proxy for common webhook formats to post into Slack
https://github.com/bluetel/chatops-webhook-proxy
aws-lambda chatops discord facebook-workplace jira jira-service-desk loggly serverless slack workable
Last synced: about 1 month ago
JSON representation
A proxy for common webhook formats to post into Slack
- Host: GitHub
- URL: https://github.com/bluetel/chatops-webhook-proxy
- Owner: bluetel
- Created: 2018-08-04T12:25:34.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-08-10T22:31:30.000Z (over 6 years ago)
- Last Synced: 2024-11-06T00:39:21.726Z (3 months ago)
- Topics: aws-lambda, chatops, discord, facebook-workplace, jira, jira-service-desk, loggly, serverless, slack, workable
- Language: JavaScript
- Size: 181 KB
- Stars: 5
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ChatOps Webhook Proxy
[](https://circleci.com/gh/Bluetel-Solutions/chatops-webhook-proxy/tree/master)
A simple proxy, written as a Lambda picoservice, for forwarding various common webhook formats (e.g. from JIRA Service Desk)
to any given Slack-compatible incoming webhook endpoint (e.g. Slack, Discord).
We use this as a production service for consuming various services in Slack, for processes ranging from release automation, to company announcements, to hiring automation. All contributions welcome!
#### Supported Services
- [Facebook Workplace](./services/facebook-workplace)
- [JIRA ServiceDesk](./services/jira-servicedesk)
- [Loggly](./services/loggly)
- [Workable](./services/workable)
- ... and more coming!
#### Updating from jira-slack-webhook
This project supercedes [jira-slack-webhook](https://github.com/Bluetel-Solutions/jira-slack-webhook), and [you can find instructions on how to migrate here](./doc/MIGRATING-FROM-JIRA-SLACK-WEBHOOK.md).
## Requirements
- Yarn
- Serverless
## Installation
1. git clone https://github.com/bluetel-solutions/chatops-webhook-proxy.git && cd chatops-webhook-proxy
2. yarn install
3. `serverless deploy --aws-profile --stage prod`
## Configuration
All configuration is managed via AWS Parameter Store. The simplest way of managing ParameterStore variables is via the AWS CLI.
You may override the default Parameter Store prefix, to allow for parallel instances of this service within the same AWS account. This is done using the `SSM_PREFIX` environment variable which must be specified when deploying via Serverless.
**Important Note**
A quirk of the aws-cli means that it will attempt to expand URLs by default. This needs to be disabled when setting the `webhook-endpoints` setting. We recommend disabling this feature: `aws configure set cli_follow_urlparam false`.
```
aws ssm put-parameter --name /service/chatops-webhook-proxy/default/webhook-endpoints --type StringList --value https://slack-compatible.webhook/endpoint/here,https://other-webhook.endpoints/here
aws ssm put-parameter --name /service/chatops-webhook-proxy/default/auth-type --type String --value "none"
aws ssm put-parameter --name /service/chatops-webhook-proxy/default/custom-prefix/webhook-endpoints --type StringList --value https://slack-compatible.webhook/endpoint/here
```
#### Configuration Parameters
- `auth-type` - Enable authentication. Current values are either `none` or `api-key`.
- `auth-api-key` - API Key authentication. Uses a query parameter: `?apiKey=`
- `webhook-endpoints` - A list of webhook endpoints in CSV format. These nest based on the `prefix` query parameter. (i.e. `?prefix=test` will result in parameters being read from `test/webhook-endpoints`)