Download the PHP package imazed/laravel-helpscout-sidebar without Composer

On this page you can find all versions of the php package imazed/laravel-helpscout-sidebar. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of imazed/laravel-helpscout-sidebar

Informations about the package laravel-helpscout-sidebar

Laravel Help Scout Sidebar

Render data from your Laravel application inside the Help Scout conversation sidebar, so support agents see who they are talking to without leaving the inbox.

Contents

In this file: Scope and versioning

Guides:

Requirements

Installation

Publish the configuration:

Publish the resources:

Add your credentials to .env:

Then point config/helpscout-sidebar.php at your customer model, if it is not App\Models\User:

Sidebar content is not published. To change what the sidebar shows, implement BuildsSidebar (see Building the sidebar). Publishing the view is for the surrounding HTML, and it is not required in order to use your own view: point view in config/helpscout-sidebar.php at any view of your own.

Help Scout setup

You need two different sets of Help Scout credentials, and they do different jobs: the sidebar app's secret verifies requests coming in, the OAuth app's credentials authenticate requests going out to the Mailbox API. They are not interchangeable.

1. The sidebar app

Create a custom app in Help Scout and point its callback URL at your route:

Set a secret on the app and put the same value in HELPSCOUT_SIDEBAR_SECRET.

If your callback URL carries static query parameters of your own, list them under signature.ignore so they are excluded before verification:

Read the security model before you use an ignored parameter for anything that matters.

2. The OAuth app

Under Your Profile → My Apps in Help Scout, you will find a Mailbox API Application with your app name. Copy the App ID and App Secret you find here into HELPSCOUT_SIDEBAR_APP_ID and HELPSCOUT_SIDEBAR_APP_SECRET.

The package uses the OAuth2 client credentials grant, which Help Scout documents for server-to-server integrations. There is no redirect URL, no consent screen, and no refresh token to manage: the package exchanges the credentials for an access token, caches it, and renews it when it expires.

Both values change if you ever uninstall and reinstall the app, and the symptoms are easy to misread. See Reading the Mailbox API section.

Security

Customer identity is established server-side. The callback's signature is verified before anything else runs, and the customer is resolved through the Mailbox API from signed identifiers only; nothing the browser sends can select a record.

A full description of the threat model (what the signature does and does not cover, what counts as attacker-controlled, and the design decisions that follow) is documented in please open an issue.

Testing

License

MIT. See LICENSE.md.

All versions of laravel-helpscout-sidebar with dependencies

PHP Build Version
Package Version
Requires php Version ^8.3
guzzlehttp/guzzle Version ^7.9
illuminate/cache Version ^12.0 || ^13.0
illuminate/contracts Version ^12.0 || ^13.0
illuminate/database Version ^12.0 || ^13.0
illuminate/http Version ^12.0 || ^13.0
illuminate/routing Version ^12.0 || ^13.0
illuminate/support Version ^12.0 || ^13.0
illuminate/view Version ^12.0 || ^13.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package imazed/laravel-helpscout-sidebar contains the following files

Loading the files please wait ...