Relay sent webhooks for repository push
events to your Discord server.
- customizable Discord message - from a detailed embed to simple commit summary
- ability to hide a commit message / repository name
- supports Discord Role mention
- supports GitHub Secret Token protection
- supports multiple Discord webhooks at once
- Download
webhook-relay.zip
file from latest release - Unzip it and upload folder content to your webhost
- Download
relay.php
andconfig.php
files and upload them to your webhost - Install Livaco Discord Webhook library using
composer install
command
- Edit
config.php
to your likings
For
$dc_webhookurl
: Edit channel > Integrations > Webhooks > Create or select one > Copy Webhook URL
For$dc_secret
: You can set a secret, which will be used to verify the webhook's authenticity. (It needs to be the same as in your repository settings and should be secure.)
- In your repository settings, add a Webhook with the following details
Payload URL:
URL to your relay.php file
(https://example.com/relay.php)
Content Type:application/x-www-form-urlencoded
Secret: Here you can enter a secret, which will be used to verify the webhook's authenticity. (It needs to be the same as in your config.php and should be secure.)
- Upon webhook creation, you should now receive a message upon every push to the repository
Too simple? Fear not, Livaco got your back!
You can customize your embed in relay.php
file at line 81
.
List of available methods to customize your embed
A complicated example by Livaco
- Livaco for his wonderful Discord Webhook library
- JustPlayerDE for his work on supporting secured GitHub webhooks