Skip to content
A very simple webhook server launching shell scripts.
Go Shell Makefile Dockerfile JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.


Build Status Go Report Card Docker pulls Donate

A very simple webhook server to launch shell scripts.



Run the following command:

$ go get -v

Or download the binary regarding your architecture:

$ sudo curl -s | bash

Or use Docker:

$ docker run -d --name=webhookd \
  -v ${PWD}/scripts:/var/opt/webhookd/scripts \
  -p 8080:8080 \
  ncarlier/webhookd \
  webhookd --scripts=/var/opt/webhookd/scripts

Note that this image extends docker:dind Docker image. Therefore you are able to interact with a Docker daemon with yours shell scripts.

Or use APT:

Finally, it is possible to install Webhookd using the Debian packaging system through this custom repository.

Note that custom configuration variables can be set into /etc/webhoockd.env file. Sytemd service is already set and enable, you just have to start it with systemctl start webhoockd.


Webhookd can be configured by using command line parameters or by setting environment variables.

Type webhookd -h to display all parameters and related environment variables.

All configuration variables are described in etc/default/webhookd.env file.


Directory structure

Webhooks are simple scripts within a directory structure.

By default inside the ./scripts directory. You can override the default using the WHD_SCRIPTS environment variable or -script parameter.


|--> /github
  |--> /
  |--> /
|--> /push.js
|--> /
|--> ...

Note that Webhookd is able to run any type of file in this directory as long as the file is executable. For example, you can execute a Node.js file if you give execution rights to the file and add the appropriate #! header (in this case: #!/usr/bin/env node).

Webhook URL

The directory structure define the webhook URL.

You can omit the script extension. If you do, webhookd will search for a .sh file. If the script exists, the output the will be streamed to the HTTP response.

The streaming technology depends on the HTTP method used. With POST the response will be chunked. With GET the response will use Server-sent events.


The script: ./scripts/foo/


echo "foo foo foo"
echo "bar bar bar"

Output using POST (Chunked transfer encoding):

$ curl -v -XPOST http://localhost:8080/foo/bar
< HTTP/1.1 200 OK
< Content-Type: text/plain; charset=utf-8
< Transfer-Encoding: chunked
< X-Hook-Id: 7
foo foo foo
bar bar bar

Output using GET (Server-sent events):

$ curl -v -XGET http://localhost:8080/foo/bar
< HTTP/1.1 200 OK
< Content-Type: text/event-stream
< Transfer-Encoding: chunked
< X-Hook-Id: 8
data: foo foo foo

data: bar bar bar

Webhook parameters

You have several way to provide parameters to your webhook script:

  • URL query parameters and HTTP headers are converted into environment variables. Variable names follows "snakecase" naming convention. Therefore the name can be altered.

    ex: CONTENT-TYPE will become content_type.

  • When using POST, body content (text/plain or application/json) is transmit to the script as parameter.


The script:


echo "Query parameter: foo=$foo"
echo "Header parameter: user-agent=$user_agent"
echo "Script parameters: $1"

The result:

$ curl --data @test.json http://localhost:8080/echo?foo=bar
Query parameter: foo=bar
Header parameter: user-agent=curl/7.52.1
Script parameter: {"foo": "bar"}

Webhook timeout configuration

By default a webhook has a timeout of 10 seconds. This timeout is globally configurable by setting the environment variable: WHD_HOOK_TIMEOUT (in seconds).

You can override this global behavior per request by setting the HTTP header: X-Hook-Timeout (in seconds).


$ curl -H "X-Hook-Timeout: 5" http://localhost:8080/echo?foo=bar

Webhook logs

As mentioned above, web hook logs are stream in real time during the call. However, you can retrieve the logs of a previous call by using the hook ID: http://localhost:8080/<NAME>/<ID>

The hook ID is returned as an HTTP header with the Webhook response: X-Hook-ID


$ # Call webhook
$ curl -v http://localhost:8080/echo?foo=bar
< HTTP/1.1 200 OK
< Content-Type: text/event-stream
< X-Hook-Id: 2
$ # Retrieve logs afterwards
$ curl http://localhost:8080/echo/2

Post hook notifications

The output of the script is collected and stored into a log file (configured by the WHD_LOG_DIR environment variable).

Once the script is executed, you can send the result and this log file to a notification channel. Currently, only two channels are supported: Email and HTTP.

Notifications configuration can be done as follow:

$ # or
$ webhookd --notification-uri=

Note that only the output of the script prefixed by "notify:" is sent to the notification channel. If the output does not contain a prefixed line, no notification will be sent.



echo "notify: Hello World" # Will be notified
echo "Goodbye"             # Will not be notified

You can override the notification prefix by adding prefix as a query parameter to the configuration URL.


HTTP notification

Configuration URI:

Options (using query parameters):

  • prefix: Prefix to filter output log

The following JSON payload is POST to the target URL:

  "id": "42",
  "name": "echo",
  "text": "foo\nbar...\n",
  "error": "Error cause... if present",

Note that because the payload have a text attribute, you can use a Mattermost webhook endpoint.

Email notification

Configuration URI:

Options (using query parameters):

  • prefix: Prefix to filter output log
  • smtp: SMTP host to use (by default: localhost:25)
  • from: Sender email (by default: webhookd <>)


You can restrict access to webhooks using HTTP basic authentication.

To activate basic authentication, you have to create a htpasswd file:

$ # create passwd file the user 'api'
$ htpasswd -B -c .htpasswd api

This command will ask for a password and store it in the htpawsswd file.

Please note that by default, the daemon will try to load the .htpasswd file.

But you can override this behavior by specifying the location of the file:

$ export WHD_PASSWD_FILE=/etc/webhookd/users.htpasswd
$ # or
$ webhookd --passwd-file /etc/webhookd/users.htpasswd

Once configured, you must call webhooks using basic authentication:

$ curl -u api:test -XPOST "http://localhost:8080/echo?msg=hello"


You can activate TLS to secure communications:

$ export WHD_TLS_LISTEN_ADDR=:8443
$ # or
$ webhookd --tls-listen-addr=:8443

This will disable HTTP port.

By default webhookd is expecting a certificate and key file (./server.pem and ./server.key). You can provide your own certificate and key with -tls-cert-file and -tls-key-file.

Webhookd also support ACME protocol. You can activate ACME by setting a fully qualified domain name:

$ export WHD_TLS_LISTEN_ADDR=:8443
$ export
$ # or
$ webhookd --tls-listen-addr=:8443

Note: On *nix, if you want to listen on ports 80 and 443, don't forget to use setcap to privilege the binary:

sudo setcap CAP_NET_BIND_SERVICE+ep webhookd

You can’t perform that action at this time.