Skip to content

Latest commit

 

History

History
56 lines (34 loc) · 2.79 KB

README.md

File metadata and controls

56 lines (34 loc) · 2.79 KB
Raw

ChatOps Webhook Proxy

CircleCI

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

Updating from jira-slack-webhook

This project supercedes jira-slack-webhook, and you can find instructions on how to migrate here.

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 <aws-profile-here> --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=<x>
  • 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)