PHPackages                             live-person-inc/live-engage-laravel - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility &amp; Helpers](/categories/utility)
4. /
5. live-person-inc/live-engage-laravel

ActiveLibrary[Utility &amp; Helpers](/categories/utility)

live-person-inc/live-engage-laravel
===================================

LiveEngage package for laravel

1.0.1(7y ago)09541MITPHPPHP &gt;=7.0CI failing

Since Jun 11Pushed 4y ago6 watchersCompare

[ Source](https://github.com/LivePersonInc/LiveEngageLaravel)[ Packagist](https://packagist.org/packages/live-person-inc/live-engage-laravel)[ RSS](/packages/live-person-inc-live-engage-laravel/feed)WikiDiscussions master Synced 3w ago

READMEChangelogDependencies (4)Versions (27)Used By (0)

Live Engage Laravel
===================

[](#live-engage-laravel)

[![Build Status](https://camo.githubusercontent.com/a319517367f94d461c08e85e1e5d9b701b3d25d97d5e1e9a22ec32fa7f389f22/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f4c697665506572736f6e496e632f4c697665456e676167654c61726176656c2f6261646765732f6275696c642e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/LivePersonInc/LiveEngageLaravel/build-status/master)[![Code Intelligence Status](https://camo.githubusercontent.com/908c072e71bb4afd57c62c592c35d0ed5e3078befc1f4468263681f5d8bb0669/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f4c697665506572736f6e496e632f4c697665456e676167654c61726176656c2f6261646765732f636f64652d696e74656c6c6967656e63652e7376673f623d6d6173746572)](https://scrutinizer-ci.com/code-intelligence)[![Scrutinizer Code Quality](https://camo.githubusercontent.com/37a5b2fd93379af94ba4e55653fb8d694c51567b8a0317aaef47a9dd7f92af04/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f4c697665506572736f6e496e632f4c697665456e676167654c61726176656c2f6261646765732f7175616c6974792d73636f72652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/LivePersonInc/LiveEngageLaravel/?branch=master)[![Code Coverage](https://camo.githubusercontent.com/52e4729f33d8c7131958f095fdebfe11919c5273eac4e41b33d4a9fb1267f3b6/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f4c697665506572736f6e496e632f4c697665456e676167654c61726176656c2f6261646765732f636f7665726167652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/LivePersonInc/LiveEngageLaravel/?branch=master)

[![Latest Stable Version](https://camo.githubusercontent.com/4def49f8be7d5c2e9e649371dbe77414f4de6036e73c4ad88ad0f13603749f85/68747470733a2f2f706f7365722e707567782e6f72672f6c6976652d706572736f6e2d696e632f6c6976652d656e676167652d6c61726176656c2f762f737461626c652e737667)](https://packagist.org/packages/live-person-inc/live-engage-laravel)[![Latest Unstable Version](https://camo.githubusercontent.com/7db147e828d05dd348abf6b1a16f9629fd7e232dd6a18efd0b2fa7723bca7dbb/68747470733a2f2f706f7365722e707567782e6f72672f6c6976652d706572736f6e2d696e632f6c6976652d656e676167652d6c61726176656c2f762f756e737461626c652e737667)](https://packagist.org/packages/live-person-inc/live-engage-laravel)[![Packagist](https://camo.githubusercontent.com/83f5390aea6cc6da6736796db6177286ce794694b20f7c6941e6ab5b382278e5/68747470733a2f2f706f7365722e707567782e6f72672f6c6976652d706572736f6e2d696e632f6c6976652d656e676167652d6c61726176656c2f642f746f74616c2e737667)](https://packagist.org/packages/live-person-inc/live-engage-laravel)

Laravel package to easily tap the LiveEngage developer APIs for such content as Engagement History, Engagement Attributes, and more...

**Use at your own risk. This package carries no SLA or support and is still currently under development.**

Installation
------------

[](#installation)

Install via composer

```
composer require live-person-inc/live-engage-laravel
```

### Register Service Provider

[](#register-service-provider)

**Note! This and next step are optional if you use laravel&gt;=5.5 with package auto discovery feature.**

Add service provider to `config/app.php` in `providers` section

```
LivePersonInc\LiveEngageLaravel\ServiceProvider::class,
```

### Register Facade

[](#register-facade)

Register package facade in `config/app.php` in `aliases` section

```
'LiveEngage' => LivePersonInc\LiveEngageLaravel\Facades\LiveEngageLaravel::class,
```

Usage
-----

[](#usage)

Create/Obtain an API key from LiveEngage with appropriate permissions for the APIs you intend to access. The `default` key is required.

Configure your keys/account in `config/services.php`

```
'liveperson' => [
    'default' => [
	    'key' => 'xxxxxxx',
	    'secret' => 'xxxxxxx',
	    'token' => 'xxxxxxx',
	    'token_secret' => 'xxxxxxx',
	    'account' => '123456',
    ]
],
```

If you want to have multiple API keys, you can add more arrays for them. The keys for each array are arbitrary, but you will need to specify them later to access specific key sets.

```
'liveperson' => [
    'default' => [
	    'key' => 'xxxxxxx',
	    'secret' => 'xxxxxxx',
	    'token' => 'xxxxxxx',
	    'token_secret' => 'xxxxxxx',
	    'account' => '123456',
    ],
    'history' => [
	    'key' => 'xxxxxxx',
	    'secret' => 'xxxxxxx',
	    'token' => 'xxxxxxx',
	    'token_secret' => 'xxxxxxx',
	    'account' => '123456',
    ],
    'attributes' => [
	    'key' => 'xxxxxxx',
	    'secret' => 'xxxxxxx',
	    'token' => 'xxxxxxx',
	    'token_secret' => 'xxxxxxx',
	    'account' => '123456',
    ]
],
```

To make an api call on a specific key set...

```
$history = LiveEngage::key('history')->engagementHistory(); //conversationHistory() for messaging
```

To use the default keyset, you need not use the `key` method at all.

```
$history = LiveEngage::engagementHistory(); //conversationHistory() for messaging
```

**Example:** Capturing engagement history between 2 date/times using global account configured above.

```
use LiveEngage;
use Carbon\Carbon;
```

```
$start = new Carbon('2018-06-01 08:00:00');
$end = new Carbon('2018-06-03 17:00:00');

/**
 * engagementHistory function.
 *
 * @access public
 * @param Carbon $start (default: null)
 * @param Carbon $end (default: null)
 * @param mixed $skills (default: [])
 */
$history = LiveEngage::engagementHistory($start, $end);
```

**Example:** Getting engagement history between 2 date/times for specific skill IDs.

```
use LiveEngage;
use Carbon\Carbon;
```

```
$start = new Carbon('2018-06-01 08:00:00');
$end = new Carbon('2018-06-03 17:00:00');
$skills = [432,676];

$history = LiveEngage::engagementHistory($start, $end, $skills);
```

`engagementHistory()` and `conversationHistory()` returns a Laravel collection of Engagement objects.

**Example:** Pulling the next "page" of data in to the collection.

```
$history->next(); // one page
```

Or

```
while ($next = $history->next()) { $history = history->merge($next) } // get all remaining data
```

**Example:** Iterate through all messages of the transcript

```
$engagement = $history->find('3498290084'); // This is a collection, so random(), first(), last() all work as well

foreach ($engagement->transcript as $message) {  // For messaging conversations, use messageRecords instead of transcript
	echo $message . "\n"; // calling the message object as a string returns its text value
}
```

Transcript is a collection of message objects, so you can access properties of the message as well.

```
echo $message->time->format('Y-m-d'); //The all time properties are Carbon date objects.
```

```
$conversation = LiveEngage::conversationHistory()->first();

foreach ($conversation->transfers as $transfer) {
	echo $transfer->targetSkillName . "\n";
}
```

**Example:** Get messaging agents availability by skill

```
$availableAgents = LiveEngage::getAgentStatus(17); //Skill ID 17

$online = $availableAgents->state('online');
$away = $availableAgents->state('away');
```

Security
--------

[](#security)

If you discover any security related issues, please email instead of using the issue tracker.

Credits
-------

[](#credits)

- [Robert Lester](https://github.com/LivePersonInc/LiveEngageLaravel)
- [All contributors](https://github.com/LivePersonInc/LiveEngageLaravel/graphs/contributors)

This package is bootstrapped with the help of [melihovv/laravel-package-generator](https://github.com/melihovv/laravel-package-generator).

###  Health Score

31

—

LowBetter than 66% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity15

Limited adoption so far

Community10

Small or concentrated contributor base

Maturity68

Established project with proven stability

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~7 days

Recently: every ~28 days

Total

20

Last Release

2803d ago

Major Versions

0.3.2 → 1.02018-08-09

### Community

Maintainers

![](https://www.gravatar.com/avatar/37a376a6bb4b688512897fd2afdef71c99a37529f1b3002d43d699843eb9cbc7?d=identicon)[roblesterjr04](/maintainers/roblesterjr04)

---

Top Contributors

[![roblesterjr04](https://avatars.githubusercontent.com/u/6423115?v=4)](https://github.com/roblesterjr04 "roblesterjr04 (7 commits)")

---

Tags

laravelliveengage

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/live-person-inc-live-engage-laravel/health.svg)

```
[![Health](https://phpackages.com/badges/live-person-inc-live-engage-laravel/health.svg)](https://phpackages.com/packages/live-person-inc-live-engage-laravel)
```

###  Alternatives

[grumpydictator/firefly-iii

Firefly III: a personal finances manager.

23.9k69.5k](/packages/grumpydictator-firefly-iii)[firefly-iii/data-importer

Firefly III Data Import Tool.

8015.8k](/packages/firefly-iii-data-importer)[markwalet/nova-modal-response

A Laravel Nova asset for Modal responses on an action.

17878.9k](/packages/markwalet-nova-modal-response)[ronasit/laravel-helpers

Provided helpers function and some helper class.

2085.6k30](/packages/ronasit-laravel-helpers)[team-nifty-gmbh/tall-datatables

Server-side rendered datatables for Laravel and Livewire

1320.9k4](/packages/team-nifty-gmbh-tall-datatables)[ecotone/laravel

Ecotone for Laravel — CQRS, Event Sourcing, Sagas, Durable Workflows, and Outbox on top of Laravel Queue, via PHP attributes.

21318.6k3](/packages/ecotone-laravel)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
