PHPackages                             websuckit/websuckit-php - 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. [HTTP & Networking](/categories/http)
4. /
5. websuckit/websuckit-php

ActiveLibrary[HTTP & Networking](/categories/http)

websuckit/websuckit-php
=======================

Websuckit PHP library

v1.0.0(2y ago)04MITPHPPHP >=8.1

Since Nov 8Pushed 2y ago1 watchersCompare

[ Source](https://github.com/WebSuckIt/web-suck-it-php)[ Packagist](https://packagist.org/packages/websuckit/websuckit-php)[ Docs](https://github.com/WebSuckIt/web-suck-it-php)[ RSS](/packages/websuckit-websuckit-php/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependencies (3)Versions (2)Used By (0)

web-suck-it-php
===============

[](#web-suck-it-php)

[![Test SDK composer package](https://github.com/WebSuckIt/web-suck-it-php/actions/workflows/test.yml/badge.svg)](https://github.com/WebSuckIt/web-suck-it-php/actions/workflows/test.yml)[![Latest Stable Version](https://camo.githubusercontent.com/af65acb21dbe6a19cc0d910acb45ef77816e4b21c726ca7257a37855e7f4f423/687474703a2f2f706f7365722e707567782e6f72672f7765627375636b69742f7765627375636b69742d7068702f76)](https://packagist.org/packages/websuckit/websuckit-php)[![Total Downloads](https://camo.githubusercontent.com/241f38d5b10dfc89882b5573a7ab9d937c0206b1fb865a0736e5ed2ba83ae767/687474703a2f2f706f7365722e707567782e6f72672f7765627375636b69742f7765627375636b69742d7068702f646f776e6c6f616473)](https://packagist.org/packages/websuckit/websuckit-php)[![Latest Unstable Version](https://camo.githubusercontent.com/a030d874d4c7854b16c4bb0e9226c968cb5b7e88d5306c79e87ece0064b876a7/687474703a2f2f706f7365722e707567782e6f72672f7765627375636b69742f7765627375636b69742d7068702f762f756e737461626c65)](https://packagist.org/packages/websuckit/websuckit-php)[![License](https://camo.githubusercontent.com/253a05597fff0a3b322d2ae1968eaa8f90f99e5f1ca092856ab46fe8494d2951/687474703a2f2f706f7365722e707567782e6f72672f7765627375636b69742f7765627375636b69742d7068702f6c6963656e7365)](https://packagist.org/packages/websuckit/websuckit-php)[![PHP Version Require](https://camo.githubusercontent.com/0462df15fd2f14973b08ed5205877d55e122f32b56b1902ee982d039047f3ab6/687474703a2f2f706f7365722e707567782e6f72672f7765627375636b69742f7765627375636b69742d7068702f726571756972652f706870)](https://packagist.org/packages/websuckit/websuckit-php)

For tutorials and more in-depth information about websuckit Channels, visit our [official docs](https://docs.websuckit.com).

Usage Overview
--------------

[](#usage-overview)

The following topics are covered:

- [Installation](https://github.com/WebSuckIt/web-suck-it-php#installation)
- [Initialization](https://github.com/websuckit/web-suck-it-php#initialization)
- [Channels](https://github.com/WebSuckIt/web-suck-it-php#channel)
    - [Create Channel](https://github.com/WebSuckIt/web-suck-it-php#channel)
    - [Get Channel](https://github.com/WebSuckIt/web-suck-it-php#channel)
    - [Get Channels](https://github.com/WebSuckIt/web-suck-it-php#get-channels-paginated)
    - [Get or Create Channel](https://github.com/WebSuckIt/web-suck-it-php#get-or-create-channel)
    - [Update Channel](https://github.com/WebSuckIt/web-suck-it-php#update-channel)
    - [Delete Channel](https://github.com/WebSuckIt/web-suck-it-php#delete-channel)
    - [Accessing a channel's websocket URL](https://github.com/WebSuckIt/web-suck-it-php#accessing-a-channels-websocket-url)

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

[](#installation)

Using composer

```
composer require websuckit/websuckit-php
```

Initialization
--------------

[](#initialization)

```
require_once 'vendor/autoload.php';

use Websuckit\WebsuckitPhp\Config;
use Websuckit\WebsuckitPhp\Websuckit;

$config = new Config($_ENV['USER_ID'], $_ENV['ACCESS_KEY'], $_ENV['PUBLIC_KEY']);
$websuckit = new Websuckit($config);
```

You can get your `USER_ID`, `ACCESS_KEY` and `PUBLIC_KEY` from the [websuckit dashboard](https://websuckit.com/api-keys).

Channel
-------

[](#channel)

Accessing a channel's websocket URL
-----------------------------------

[](#accessing-a-channels-websocket-url)

It is possible to access a channel websocket URL by channel name, through the `getConnectionUrl` function

```
use Websuckit\WebsuckitPhp\Types\ChannelConnectionUrlConfig;

$channel = new ChannelConnectionUrlConfig('CHANNEL-NAME', 'CHANNEL-PASS-KEY', false);
$connection_url = $websuckit->getConnectionUrl($channel);
```

### Create channel

[](#create-channel)

```
$channel = $websuckit->createChannel('new-channel', 2);
```

### Get channel

[](#get-channel)

```
$channel = $websuckit->getChannel('CHANNEL-NAME');
```

### Get channels (paginated)

[](#get-channels-paginated)

```
$page = "0";
$per_page = "10";

//search variable that can be null
$search = "search-term"
$channels = $websuckit->getChannels($page, $per_page, $search);
```

### Get or Create channel

[](#get-or-create-channel)

```
$channel = $websuckit->getOrCreateChannel('CHANNEL-NAME');
```

### Update channel

[](#update-channel)

```
$channel = $websuckit->updateChannel('CHANNEL-ID', "CHANGE-CHANNEL-NAME", false, 2);
```

### Delete channel

[](#delete-channel)

```
$websuckit->deleteChannel('CHANNEL-ID');
```

###  Health Score

23

—

LowBetter than 27% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity3

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity51

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 82.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

Unknown

Total

1

Last Release

918d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/1f2b40fcfae38ea68f43db306dc237041838d9146db9012ef0e71800f1117414?d=identicon)[websuckit](/maintainers/websuckit)

---

Top Contributors

[![wizzywit](https://avatars.githubusercontent.com/u/40175713?v=4)](https://github.com/wizzywit "wizzywit (51 commits)")[![deven96](https://avatars.githubusercontent.com/u/23453888?v=4)](https://github.com/deven96 "deven96 (11 commits)")

---

Tags

websuckithttpwebsocketrealtimecommunicationwebsuckit

###  Code Quality

TestsPest

### Embed Badge

![Health badge](/badges/websuckit-websuckit-php/health.svg)

```
[![Health](https://phpackages.com/badges/websuckit-websuckit-php/health.svg)](https://phpackages.com/packages/websuckit-websuckit-php)
```

###  Alternatives

[hhxsv5/laravel-s

🚀 LaravelS is an out-of-the-box adapter between Laravel/Lumen and Swoole.

3.9k676.0k10](/packages/hhxsv5-laravel-s)[swow/swow

Coroutine-based multi-platform support engine with a focus on concurrent I/O

1.3k2.1M84](/packages/swow-swow)[pusher/pusher-http-laravel

\[DEPRECATED\] A Pusher bridge for Laravel

400509.0k3](/packages/pusher-pusher-http-laravel)[centrifugal/phpcent

PHP library to communicate with Centrifugo HTTP API

1822.3M4](/packages/centrifugal-phpcent)[amphp/websocket-client

Async WebSocket client for PHP based on Amp.

1613.0M39](/packages/amphp-websocket-client)[sl4mmer/phpcent

PHP library to communicate with Centrifugo HTTP API

182293.0k1](/packages/sl4mmer-phpcent)

PHPackages © 2026

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