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:
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
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
Note: The emoji to URL is designed to take a
icon_emoji value and convert it to a URL.
EmojiURLFormat is a
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
$ heroku create $ git push heroku master $ heroku open
The 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_ENGINEThe engine to be used:
valyala/fasthttp. Leave empty for
eawsy/aws-lambda-go-shimas it does not require a server to be started.
CHATHOOKS_TOKENSComma-delimited list of verification tokens. No extra leading or trailing spaces.
CHATHOOKS_ENGINEenvironment variable to
For testing purposes, use:
$ go run main.go
For production services, compile and run the binary:
$ go build main.go $ ./main
To 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:
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:
$ aws lambda update-function-code --function-name='MyFunction' --zip-file='fileb://main.zip' --publish --region='us-east-1'
aws-update.sh file has this command with default settings.
Make sure to set your AWS credentials file.
401 Unauthorized Error. If you can run a test on API Gateway and have deployed your API but are running into a 401 Unauthorized error.....
inputTyperequired An handler service like
outputTyperequired An adapter service like
urlrequired A webhook URL or UID, e.g.
tokenoptional 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
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,
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 easiest way to add a handler is to inspect the code of an existing handler and build something similar. It needs satisfy the
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
Chathooks is built using: