roarbb/webhooker

Github Webhook Helper

Installation

The recommended way to install Webhooker is through Composer., _(*1)

# Install Composer
curl -sS https://getcomposer.org/installer | php

Next, run the Composer command to install the latest stable version of Webhooker:, _(*2)

composer require roarbb/webhooker

Prerequisites

Make sure that you have rights to update files on server, _(*3)

chown -R www-data /path/to/website/root

Webhook config

Step 1

In website root, create webhook.php file, _(*4)

basic

<?php

use Webhook\Hook;

include_once('vendor/autoload.php');

$hook = new Hook();
echo $hook->pull();

If you want to secure your webhook with secret token (token in file)

webhook.php, _(*5)

<?php

use Webhook\Hook;

include_once('vendor/autoload.php');

$hook = new Hook();
$hook->setConfigFile(__DIR__ . '/config.neon');

if ($hook->isValidSignature()) {
    echo $hook->pull();
}

config.neon, _(*6)

github:
    secret: secretToken123

If you want to secure your webhook with secret token (token as string)

webhook.php, _(*7)

<?php

use Webhook\Hook;

include_once('vendor/autoload.php');

$hook = new Hook();
$hook->setGithubSecret('secretToken123');

if ($hook->isValidSignature()) {
    echo $hook->pull();
}

Step 2

Login to github, and set up your webhook. Link: https://github.com/[username]/[repository]/settings/hooks, _(*8)

, _(*9)

Payload Url: Link to your webhook.php
Content Type: application/json
Secret: secretToken123
Which events would you like to trigger this webhook? - Just the push event.
Active: checked, _(*10)

It may looks like this: , _(*11)

Final Step

On producion server: * Double-check permissions * Don't forget to run composer update, _(*12)

You can check your automatic updates in Webhooks/Manage Webhook -> Recent Deliveries , _(*13)

Enjoy your new workflow!