Skip to content

Latest commit

 

History

History
44 lines (30 loc) · 1.52 KB

README.md

File metadata and controls

44 lines (30 loc) · 1.52 KB

Heap Helper

GitHub issues GitHub stars GitHub license

Description

Heap Helper is a simple wrapper for the Heap server side API.

Heap Helper provides:

  • simple integration with the Heap server side API.
  • wrapper for the Heap API endpoints.
  • individual resources that the API is expecting to be provided.

You can learn more about Heap here: https://heapanalytics.com/

$configuration = new \Mitquinn\HeapHelper\HeapConfiguration('apiKey', 'appId');
$heapHelper = new \Mitquinn\HeapHelper\HeapHelper($configuration);

$event = new \Mitquinn\HeapHelper\Resources\HeapEvent(
    'eventName', 
    '[email protected]', 
    ['propertyKey' => 'propertyValue']
);

$heapResponse = $heapHelper->track($event);

Installation

The recommended way to install Heap Helper is through Composer.

composer require mitquinn/heap-helper

License

Heap Helper is made available under the GNU General Public License (GNU). Please see the License File for more information.

Contributors