This is wethook, a webhook receiver and task runner.

Usage

Requirements

• PHP >= 7.1
• ext-mbstring
• Linux (Other POSIX OS may also work)

Extensions that are enabled by default are omitted.

Running the server

php wethook.php

Add the switch -h to get help about command line usage.

The web UI

The web UI provides some info and stats about the server. Just visit http://ipaddr:port/ in a browser, where hostname:port is the listening ip address and port of the server.

Configuration

Configuration is done in the file config/config.php. In case when the file does not exist, it must be manually created. In order to make modifications take effect, the server must be restarted.

The file config/config.php.dist may serve as an example or template.

Drivers

Webhook requests come in different formats. Drivers handle those differences and produce uniform results. Currently these drivers are built-in:

• Gitea
• Gitee
• Github
• Gitlab

Writing hook scripts

Writing hook scripts is the same as writing any executable scripts. The following environment variables are available:

• WETHOOK_ENDPOINT The endpoint that received the webhook request.
• WETHOOK_DRIVER The identifier of the driver.
• WETHOOK_EVENT The name of the event.
• WETHOOK_TARGET The URL of the target resource that triggered the event.
• WETHOOK_DATA Any other data the event may carry, as a JSON string.

TODO

• Enqueue tasks in different queues according to their working directories.
• More drivers.

LICENSE

MIT