PHPackages                             onix-systems-php/hyperf-support - 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 & Helpers](/categories/utility)
4. /
5. onix-systems-php/hyperf-support

ActiveExtension[Utility & Helpers](/categories/utility)

onix-systems-php/hyperf-support
===============================

Support module for Hyperf web applications

v1.1.9(1y ago)04113PHPPHP >=8.1

Since Apr 2Pushed 1y ago2 watchersCompare

[ Source](https://github.com/onix-systems-php/hyperf-support)[ Packagist](https://packagist.org/packages/onix-systems-php/hyperf-support)[ RSS](/packages/onix-systems-php-hyperf-support/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (10)Dependencies (12)Versions (30)Used By (0)

onix-systems-php/hyperf-support
===============================

[](#onix-systems-phphyperf-support)

**Hyperf-support** is a package for fluently managing your tickets and comments within Slack, Trello and other systems. Made by [onix-systems-php](https://github.com/onix-systems-php)

Installation:
-------------

[](#installation)

```
composer require onix-systems-php/hyperf-support
```

Publishing the config:
----------------------

[](#publishing-the-config)

```
php bin/hyperf.php vendor:publish onix-systems-php/hyperf-support
```

Configuration
-------------

[](#configuration)

### Configure `app`

[](#configure-app)

1. `domain` - application url e.g.().
2. `name` - application name.
3. `team_name` - name of your support team.
4. `user_model_class` - User model path. Then implement `OnixSystemsPHP\HyperfSupport\Contract\SupportUserInterface` contract in the model class.

### Configure `integrations.trello`

[](#configure-integrationstrello)

1. `key` - API Key. (You may find it here: )
2. `token` - Authorization token.
3. `webhook_url` - `app.domain` + `/v1/support/webhooks/trello`.
4. `board_name` - Trello board name.
5. `members` - For each type of ticket specify members which should be attached to the card on Trello.
6. `lists` - Specify mapping for each status of ticket with corresponding list on Trello.
7. `custom_fields` - Determine which custom fields should be on card on Trello.
8. `trigger_lists` - Specify trigger lists on Trello. These lists determine whether to notify users if the ticket moved in one of these lists.
9. `is_private_discussion` - This option must be `true` or `false`. If `true`, discussion under the ticket on Trello will be private and anyone can see it except on Trello.
10. `keys_to_source` - Specify `your_api_username` => `your_source`.

### Configure `integrations.slack`

[](#configure-integrationsslack)

1. `token` - Bot Authorization key.
2. `channel_id` - Slack channel id.
3. Don't forget to enable subscriptions for your Slack bot and specify request URL: `app.domain` + `/v1/support/webhooks/trello`.
4. `app_icon` - Your application's icon url. e.g.
5. `members` - For each type of ticket specify members which should be mentioned on Slack ticket. **Without '@'.**
6. `custom_fields` - Determine which custom fields should be showed on Slack ticket.
7. `is_private_discussion` - This option must be `true` or `false`. If `true`, discussion under the ticket on Slack will be private and anyone can see it except on Slack.
8. `keys_to_source` - Specify `your_slack_channel_id` => `your_source`.

### Configure `routes`

[](#configure-routes)

`require_once './vendor/onix-systems-php/hyperf-support/publish/routes.php';`

Basic Usage
-----------

[](#basic-usage)

### Creating simple ticket:

[](#creating-simple-ticket)

Try to send this `JSON` to `/v1/support/tickets` via `POST` method.

```
{
  "source": "default",
  "title": "Lorem ipsum.",
  "content": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.",
  "custom_fields": {
    "type": "Tweak",
    "level": 3,
    "priority": "Medium",
    "status": "New"
  },
  "page_url": "https://google.com"
}
```

You should get something like this object:

```
{
    "id": 1,
    "title": "Lorem ipsum.",
    "content": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.",
    "source": "default",
    "custom_fields": {
        "type": "Tweak",
        "level": 3,
        "status": "New",
        "priority": "Medium"
    },
    "created_by": 6,
    "modified_by": null,
    "deleted_by": null,
    "completed_at": null,
    "trello_id": "660bc45ce19c204556caf1f5",
    "trello_short_link": "qTHPdFoL",
    "slack_id": "1712047194.779679",
    "page_url": null,
    "created_at": "2024-04-02 08:39:54",
    "updated_at": "2024-04-02 08:40:36",
    "deleted_at": null,
    "files": []
}
```

Finally, it should appear on Slack and Trello.

### Creating ticket with files:

[](#creating-ticket-with-files)

Logic the same as for creating simple ticket, but you need to pass array with files' IDs:

```
{
    ...
    "files": [1, 2, 3]
}
```

Finally, the ticket should appear on Slack and Trello with attached files.

### Updating ticket on Trello.

[](#updating-ticket-on-trello)

Once the `ticket.done_status` is "Done" everytime when ticket moved to Done list on Trello the ticket will be marked as "completed".

###  Health Score

36

—

LowBetter than 82% of packages

Maintenance46

Moderate activity, may be stable

Popularity14

Limited adoption so far

Community14

Small or concentrated contributor base

Maturity61

Established project with proven stability

 Bus Factor1

Top contributor holds 65.5% 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 ~12 days

Recently: every ~3 days

Total

29

Last Release

420d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/8e1c2e991197c9603eb160eb27e1be423eb683ee2eed293288993936444c20bb?d=identicon)[onix-systems-php](/maintainers/onix-systems-php)

---

Top Contributors

[![realihorrud](https://avatars.githubusercontent.com/u/82283436?v=4)](https://github.com/realihorrud "realihorrud (95 commits)")[![vkarchevskyi](https://avatars.githubusercontent.com/u/80644867?v=4)](https://github.com/vkarchevskyi "vkarchevskyi (36 commits)")[![ihorrudnix](https://avatars.githubusercontent.com/u/144118594?v=4)](https://github.com/ihorrudnix "ihorrudnix (10 commits)")[![vmikhav](https://avatars.githubusercontent.com/u/11061723?v=4)](https://github.com/vmikhav "vmikhav (4 commits)")

---

Tags

phpslacktrellosupporthyperf

###  Code Quality

TestsPHPUnit

Static AnalysisPHPStan

Code StylePHP CS Fixer

Type Coverage Yes

### Embed Badge

![Health badge](/badges/onix-systems-php-hyperf-support/health.svg)

```
[![Health](https://phpackages.com/badges/onix-systems-php-hyperf-support/health.svg)](https://phpackages.com/packages/onix-systems-php-hyperf-support)
```

###  Alternatives

[hyperf/watcher

Hot reload watcher for Hyperf

17846.7k27](/packages/hyperf-watcher)

PHPackages © 2026

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