webhooker/webhooker-sdk

SDK for communicating with the WebHooker.io API

WebHooker SDK for PHP

![Software License][ico-license] ![Total Downloads][ico-downloads], _(*1)

Interact with the WebHooker.io API, _(*2)

Install

Via Composer, _(*3)

composer require webhooker/webhooker-sdk

You must also have Guzzle installed. By default, the package is only compatible with Guzzle 6:, _(*4)

composer require guzzlehttp/guzzle

Usage

Instantiate:, _(*5)

$webhooker = Webhooker\Webhooker::usingGuzzle('YOUR-API-KEY');

Add a subscriber:, _(*6)

$subscriber = $webhooker->addSubscriber('Their Name Here');

$subscriber->id;

Add an endpoint for the subscriber to receive messages:, _(*7)

// you can use "jsonSubscription" or "xmlSubscription"
$subscription = $webhooker->subscriber($id)->jsonSubscription($tenantKey, $deliveryUrl, $secret)->save();
$subscription = $webhooker->subscriber($id)->xmlSubscription($tenantKey, $deliveryUrl, $secret)->save();

// additional options for a subscription, e.g. Basic Auth, or "Legacy Payloads"
$subscription = $webhooker->subscriber($id)
  ->jsonSubscription($tenantKey, $deliveryUrl, $secret)
  ->basicAuth($username, $password)
  ->legacyPayload('p_reply')
  ->save();

$subscription->id;

Send a JSON message:, _(*8)

// $jsonData can be something JSON-able (array/object) or a pre-encoded JSON string
$webhooker->notify('account-1', 'something.happened')->json($jsonData)->send();

Or, because JSON is very common, just pass it directly to the send() method:, _(*9)

$webhooker->notify('account-1', 'something.happened')->send($jsonData);

Send an XML message:, _(*10)

// $xmlData must be an XML string
$webhooker->notify('account-1', 'something.happened')->xml($xmlData)->send();

Send both XML and JSON messages:, _(*11)

$webhooker->notify('account-1', 'something.happened')->xml($xmlData)->json($jsonData)->send();

Change log

Please see CHANGELOG for more information what has changed recently., _(*12)

Testing

composer test

Contributing

Please see CONTRIBUTING and CONDUCT for details., _(*13)

Security

If you discover any security related issues, please email dan@radweb.co.uk instead of using the issue tracker., _(*14)

License

The MIT License (MIT). Please see License File for more information., _(*15)