Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Current »

WebHooks plugin allows you to send notifications to external scripts. It works by sending http requests with event data to url defined in your webhook.

Installation

Proceed to Settings » Module. Search and activate "WebHooks" module.

After that you can navigate to Extras » WebHooks to manage your webhooks.

WebHook settings

This configuration can be changed at any time.

  • Name - name or description that will identify your webhook
  • URL to be called - provide an URL to the script that will handle notifications, it does not have to be public but it has to be reachable from your HostBill installation.
    • Verify SSL certificate - check this option to verify that SSL certificate is valid before sending data.
  • Status - set disabled if you do not want to send notification. 
  • Request Content type - content type for the http request
  • Secret - It will be generated automatically after you add new webhook, it can be used to validate requests.
  • Events -  Select which events will be sent to specified url
    Adding new webhook

HTTP Request

Each request will include special headers that will allow you to validate it and with details about executed event and webhook

  • HB-Hook - system ID for this webhook that sent this request

  • HB-Event - event name eg. after_clientadded

  • HB-Timestamp - timestamp of this request, used to validate requests
  • HB-Signature - signature generated for request data and timestamp

Request body will depend on selected content type.

application/json
{"firsname": "Joe", "lastname": "Doe"}
application/x-www-form-urlencoded
firstname=Joe&lastname=Doe

Request validation

Each request is signed with your secret key, this allows you to validate that the events were sent by your HostBill installation, not by a third party. 

Here are the steps required to validate request signature.

Step 1: Obtain timestamp and signature from response headers, the HB-Signature header contains signature that you want to verify and HB-Timestamp contains timestamp used to generate that signature.

Step 2: Prepare the payload string by concatenating:

  • The timestamp (as a string)
  • The actual request body (json string or x-www-form-urlencoded data)

Step 3: Compute a HMAC with the SHA256 hash function. Use secret as the key, and use the payload string as the message.

Step 4: Compare the signature in the HB-Signature header to the one computed in step 3. If it matches, compute the difference between the current timestamp and the received timestamp, then decide if the difference is within your tolerance.

Example 
<?php

$secret = ''; // paste your Secret here

//fetch request body
$data = file_get_contents('php://input');
$payload = $_SERVER["HTTP_HB_TIMESTAMP"] . $data;

$signature = hash_hmac('sha256', $payload, $secret);

//compare signature in header with the one computed above
if($signature !== $_SERVER["HTTP_HB_SIGNATURE"])
    die('invalid signature')

// signature valid, verify timestamp
if($_SERVER["HTTP_HB_TIMESTAMP"] < time() - 60)
    die('timestamp older than 60 sec')


Note: Webhooks plugin helps you by showing sample code for each webhook you generate in webhook details.


  • No labels