helpscout / apps
Client library to assist with building dynamic apps that integrate with the Help Scout UI
Installs: 254 618
Dependents: 2
Suggesters: 0
Security: 0
Stars: 36
Watchers: 44
Forks: 4
Open Issues: 1
Requires
- php: >=5.3.2
- ext-curl: *
Requires (Dev)
This package is auto-updated.
Last update: 2023-09-20 03:04:59 UTC
README
Client library to assist with building custom apps that integrate with Help Scout. More information: http://developer.helpscout.net/custom-apps/
Current Version
- 1.1.1
Please see the Changelog for details.
Installation
The Help Scout apps client can be installed using Composer.
Composer
Inside of composer.json specify the following:
{
"require": {
"helpscout/apps": "1.1.*"
}
}
Example Usage (1)
use HelpScoutApp\DynamicApp;
include 'src/HelpScoutApp/DynamicApp.php';
$app = new DynamicApp('SECRET-KEY-HERE');
if ($app->isSignatureValid()) {
$customer = $app->getCustomer();
$user = $app->getUser();
$convo = $app->getConversation();
$mailbox = $app->getMailbox();
$html = array(
'<p>Convo</p>',
'<ul>',
'<li>Id: ' . $convo->getId() . '</li>',
'<li>Number: ' . $convo->getNumber() . '</li>',
'<li>Subject: ' . $convo->getSubject() . '</li>',
'</ul>',
'<p>Customer</p>',
'<ul>',
'<li>First: ' . $customer->getFirstName() . '</li>',
'<li>Last: ' . $customer->getLastName() . '</li>',
'<li>Email: ' . $customer->getEmail() . '</li>',
'</ul>',
'<p>User</p>',
'<ul>',
'<li>First: ' . $user->getFirstName() . '</li>',
'<li>Last: ' . $user->getLastName() . '</li>',
'<li>Id: ' . $user->getId() . '</li>',
'</ul>',
'<p>Mailbox</p>',
'<ul>',
'<li>ID: ' . $mailbox->getId() . '</li>',
'<li>Email: ' . $mailbox->getEmail() . '</li>',
'</ul>'
);
echo $app->getResponse($html);
} else {
echo 'Invalid Request';
}
Example Usage (2)
use HelpScoutApp\DynamicApp;
include 'src/HelpScoutApp/DynamicApp.php';
$app = new DynamicApp('SECRET-KEY-HERE');
if ($app->isSignatureValid()) {
echo $app->getResponse('<p>Hello World</p>');
} else {
echo 'Invalid Request';
}