PHPackages helpspot/helpspot - 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. [API Development](/categories/api) 4. / 5. helpspot/helpspot ActiveLibrary[API Development](/categories/api) helpspot/helpspot ================= A PHP wrapper for the HelpSpot help desk api 1.0.6(1y ago)87.0k↓50%5MITPHPPHP >=5.5 Since Dec 5Pushed 1y ago2 watchersCompare [ Source](https://github.com/helpspot/helpspot-php)[ Packagist](https://packagist.org/packages/helpspot/helpspot)[ Docs](https://github.com/helpspot/helpspot-php)[ RSS](/packages/helpspot-helpspot/feed)WikiDiscussions master Synced 1mo ago READMEChangelog (7)Dependencies (1)Versions (8)Used By (0) HelpSpot Help Desk Software =========================== [](#helpspot-help-desk-software) This is the PHP SDK to the HelpSpot API. The SDK can work with both the public and private (staff) API. Please read the full documentation for each API method here: - [API Overview](https://support.helpspot.com/index.php?pg=kb.page&id=161) - [Public API Methods](https://support.helpspot.com/index.php?pg=kb.page&id=163) - Access as the customer - [Private API Methods](https://support.helpspot.com/index.php?pg=kb.page&id=164) - Access as a staff person with a HelpSpot license Install ------- [](#install) Via Composer ``` $ composer require helpspot/helpspot ``` Loading ------- [](#loading) If your framework handles autoloading you can simply use a **use** statement at the top of your php file to access HelpSpot. If it doesn't, you can load in HelpSpot with the require statement shown below plus using the **use** statement at the top of the file you want to access HelpSpot in. ``` require_once "vendor/autoload.php"; use helpspot\helpspot\helpspot; // Access HelpSpot in your functions and methods in this file ``` Usage ----- [](#usage) ### Authentication [](#authentication) You can authenticate either via an api key or a username and password combination. The API key is now the recommended authentication method and is the only method available if the HelpSpot instance uses SAML or LDAP authentication. API Key: ``` $helpspot = new helpspot('https://company.helpspot.com', '', '','apikey'); ``` Username Password: ``` $helpspot = new helpspot('https://company.helpspot.com', 'user@example.com', 'password'); ``` ### Create a request using the private api [](#create-a-request-using-the-private-api) ``` $helpspot = new helpspot('https://company.helpspot.com', 'user@example.com', 'password'); $helpspot->post('private.request.create', [ 'sEmail' => 'customer@company.com', 'tNote' => 'testing', 'xCategory' => 1 ]); ``` ### Update a request using the private api [](#update-a-request-using-the-private-api) ``` $helpspot = new helpspot('https://company.helpspot.com', 'user@example.com', 'password'); $helpspot->post('private.request.update', [ 'xRequest' => 12400, 'fNoteType' => 1, // A public note 'tNote' => 'Update the request with this note.', ]); ``` ### Get a request using the private api [](#get-a-request-using-the-private-api) ``` $helpspot = new helpspot('https://company.helpspot.com', 'user@example.com', 'password'); $request = $helpspot->get('private.request.get', [ 'xRequest' => 12400 ]); echo $request->sEmail; ``` ### Create a request using the public api [](#create-a-request-using-the-public-api) ``` $helpspot = new helpspot('https://company.helpspot.com'); $helpspot->post('request.create', [ 'sEmail' => 'customer@company.com', 'tNote' => 'testing' ]); ``` ### Checking for errors [](#checking-for-errors) ``` $helpspot = new helpspot('https://company.helpspot.com', 'user@example.com', 'password'); $request = $helpspot->get('private.request.get', [ 'xRequest' => 12400 ]); if($helpspot->hasError()) { foreach($helpspot->getErrors() as $error) { echo $error->id .' '. $error->description; } } else { echo $request->sEmail; } ``` Security -------- [](#security) If you discover any security related issues, please email instead of using the issue tracker. Credits ------- [](#credits) - UserScape Inc. License ------- [](#license) The MIT License (MIT). Please see [License File](LICENSE.md) for more information. ### Health Score 43 — FairBetter than 91% of packages Maintenance50 Moderate activity, may be stable Popularity30 Limited adoption so far Community17 Small or concentrated contributor base Maturity63 Established project with proven stability Bus Factor1 Top contributor holds 53.3% 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 ~514 days Recently: every ~771 days Total 7 Last Release 365d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/d4d3976aef1be1d0fd120241b9f2d4e13e1fedafb44e6093c8410c0e47b3ab33?d=identicon)[ianlandsman](/maintainers/ianlandsman) ![](https://www.gravatar.com/avatar/a9a1168f988720e92a8e4b0b70ee310c5bb6b50c6db65f58c12e61d044e8661a?d=identicon)[mpstenson](/maintainers/mpstenson) --- Top Contributors [![ianlandsman](https://avatars.githubusercontent.com/u/53144?v=4)](https://github.com/ianlandsman "ianlandsman (8 commits)")[![mpstenson](https://avatars.githubusercontent.com/u/1500588?v=4)](https://github.com/mpstenson "mpstenson (3 commits)")[![proclame](https://avatars.githubusercontent.com/u/2464413?v=4)](https://github.com/proclame "proclame (2 commits)")[![ericlbarnes](https://avatars.githubusercontent.com/u/116662?v=4)](https://github.com/ericlbarnes "ericlbarnes (1 commits)")[![fideloper](https://avatars.githubusercontent.com/u/467411?v=4)](https://github.com/fideloper "fideloper (1 commits)") --- Tags HelpSpothelp desk softwareticket software ### Embed Badge ![Health badge](/badges/helpspot-helpspot/health.svg) ``` [![Health](https://phpackages.com/badges/helpspot-helpspot/health.svg)](https://phpackages.com/packages/helpspot-helpspot) ``` ### Alternatives [tencentcloud/tencentcloud-sdk-php TencentCloudApi php sdk 3731.2M42](/packages/tencentcloud-tencentcloud-sdk-php)[convertkit/convertkitapi Kit PHP SDK for the Kit API 2167.1k1](/packages/convertkit-convertkitapi)[mapado/rest-client-sdk Rest Client SDK for hydra API 1125.9k2](/packages/mapado-rest-client-sdk) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)