Chathooks is a webhook proxy service that converts generic outbound webhook messages to a canonical CommonChat message format which is then sent to any chat / team messaging platform supported by the CommonChat chat post abstraction library.
This is useful because:
- many services with outbound webhooks need to be formatted before they can be consumed by an inbound webhook. This proxy service does the conversion so you don't have to. The code is all open source so customizations can be done easily.
- the conversion can be done one time for all chat / team messaging solutions supported by CommonChat.
- one service can proxy an arbitrary number of webhook sources and event types so you don't have to configure multiple inbound webhooks going to the same group / channel.
See the following video to get started quickly:
Chathooks supports multiple HTTP engines including the following:
Multiple input webhook formats are supported via handlers. New ones can be easily created by using the handlers.Handler interface.
- Aha!
- AppSignal
- Apteligent/Crittercism
- Bugsnag
- Circle CI
- Codeship
- Confluence
- Datadog
- Desk.com
- Enchant
- GoSquared
- Heroku
- Librato
- Magnum CI
- Marketo
- Nixstats (Slack webhook proxy)
- OpsGenie
- Papertrail
- Pingdom
- Raygun
- Runscope
- Semaphore CI, Deploy
- StatusPage
- Travis CI
- Userlike
- VictorOps
Here is an exmaple Webhook Message from Travis CI formatted for Glip.
The above are "outbound" webhook formats from the perspective of the service providing the events.
A special webhook format supported is the Slack "inbound" webhook format. This format message isn't sent by Slack but is accepted by Slack. It is useful to allow modification of messages already formatted for Slack.
Chathooks can post messages to any service supported by CommonChat. New services can be added by creating an adapter using the commonchat.Adapter interface.
Note: The emoji to URL is designed to take a icon_emoji value and convert it to a URL. EmojiURLFormat is a fmt format string with one %s verb to represent the emoji string without :. You can use any emoji image service. The example shows the emoji set from github.com/wpeterson/emoji forked and hosted at grokify.github.io/emoji/.
$ go get github.com/grokify/chathooks
or
$ heroku create
$ git push heroku master
$ heroku openThe following will generate a main.zip file to upload to AWS Lambda.
$ go get github.com/grokify/chathooks
$ cd chathooks
$ sh aws-package.sh
$ ls main.zip
Chathooks uses two environment variables:
| Variable Name | Value |
|---|---|
CHATHOOKS_ENGINE |
The engine to be used: awslambda for aws/aws-lambda-go, nethttp for net/http and fasthttp for valyala/fasthttp. Leave empty for eawsy/aws-lambda-go-shim as it does not require a server to be started. |
CHATHOOKS_TOKENS |
Comma-delimited list of verification tokens. No extra leading or trailing spaces. |
- To adjust supported handlers, edit server.go to add and remove handlers.
- Set the
CHATHOOKS_ENGINEenvironment variable tonethttporfasthttp. - Start the service in
main.go.
For testing purposes, use:
$ go run main.goFor production services, compile and run the binary:
$ go build main.go
$ ./mainTo use the AWS Lambda engine, you need an AWS account. If you don't hae one, the free trial account includes 1 million free Lambda requests per month forever and 1 million free API Gateway requests per month for the first year.
See the AWS docs for deployment:
https://docs.aws.amazon.com/lambda/latest/dg/lambda-go-how-to-create-deployment-package.html
Using the aws-cli you can use the following approach:
$ GOOS=linux go build main.go
$ zip main.zip ./main
# --handler is the path to the executable inside the .zip
$ aws lambda create-function \
--region region \
--function-name Chathook \
--memory 128 \
--role arn:aws:iam::account-id:role/execution_role \
--runtime go1.x \
--zip-file fileb://main.zip \
--handler main
You can use the aws-package.sh shell script to package your handler.
Note: you can install the aws-cli using the appropriate command below:
$ pip install awscli
$ pip3 install awscli
After installation, you may need to add your Python bin directory to your path. The following are examples for OS X.
$ export PATH=$PATH:/Users/~/Library/Python/2.7/bin
$ export PATH=$PATH:/Library/Frameworks/Python.framework/Versions/3.6/bin
You can update the Lambda function code using the following:
https://docs.aws.amazon.com/cli/latest/reference/lambda/update-function-code.html
$ aws lambda update-function-code --function-name='MyFunction' --zip-file='fileb://main.zip' --publish --region='us-east-1'
The aws-update.sh file has this command with default settings.
Make sure to set your AWS credentials file.
- Configure AWS Lambda Function
- Create AWS Lambda function
- Set
CHATHOOKS_ENGINEtoawslambda - Set
CHATHOOKS_TOKENas desired - Set Handler to
main
- Configure API Gateway
- Create "REST" API
- Select "New API"
- Enter "API name"
- Click "Create API"
- Select "Actions" > "Create Resource" on "/"
- Click "Configure as proxy resource"
- Use Resource Path
{proxy+} - Click "Enable API Gateway CORS"
- Click "Create Resource"
- Leave "Integration Type" as "Lambda Function Proxy"
- In "Lambda Function", paste in your Lamda ARN
- Click "Save"
- Click "Actions" > "Deploy API" and create stage if necessary.
- Copy "Invoke URL" which should end in
{stageName}
- 401 Unauthorized Error: If you can run a test on API Gateway and have deployed your API but are running into a HTTP Status 401 Unauthorized error, check to see if you have configured the
CHATHOOKS_TOKENenvironment variable but not entered atokenquery string parameter.
- create a Glip webhook
- use webhook URL's GUID to create the proxy URL as shown below
- use the proxy URL in your outbound webhook service
| Query Parameter | Required? | URL |
|---|---|---|
inputType |
required | An handler service like marketo |
outputType |
required | An adapter service like glip |
outputURL |
required | A webhook URL or UID, e.g. 11112222-3333-4444-5555-666677778888 |
outputFormat |
optional | one of [nocard,card] |
token |
optional | Must be included if service is configured to use auth tokens |
The webhook proxy URLs support both inbound and outbound formats. When available, these should be represented in the handler key.
To create the Glip webhook and receive a webhook URL do the following:
At the top of any conversation page, click the Settings gear icon and then click Add Integration.
Select the Glip Webhooks integration.
Once you get the URL, the proxy URL is created by appending the GUID (e.g. 1112222-3333-4444-5555-666677778888) to the proxy URL base, hooks?inputType=slack&outputType=glip (e.g. https://glip-proxy.example.com/hooks?inputType=slack&outputType=glip&url=1112222-3333-4444-5555-666677778888). Use the proxy URL in the app that is posting the Slack webhook and the payload will be sent to Glip.
It's easy to test handlers by sending messages using the example messages per service.
Code is provided to both send the message locally (without HTTP) and over HTTP.
The following is an example curl command that can be used with any host, local or remote.
curl -XPOST 'https://example.com/webhook?inputType=datadog&outputType=glip&url=https://hooks.glip.com/webhook/11111111-2222-3333-4444-555566667777' --data "@docs/handlers/datadog/event-example_formatted1.json" -H 'Content-Type: application/json' --verbose
The easiest way to add a handler is to inspect the code of an existing handler and build something similar. It needs satisfy the handlers.Handler interface.
Use godep to rebuild the vendor directory with:
$ rm -rf Godeps
$ export GO15VENDOREXPERIMENT=1
$ godep save ./...
More information on deploying Go on Heroku here:
Set up your own Go app on Heroku easily using goheroku.
Chathooks is built using: