PHPackages                             omneo/omneo-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. [API Development](/categories/api)
4. /
5. omneo/omneo-php

ActiveLibrary[API Development](/categories/api)

omneo/omneo-php
===============

PHP library for the Omneo API

0.3.14(2y ago)122.3k1[1 PRs](https://github.com/omneo/omneo-php/pulls)MITPHP

Since May 1Pushed 2y ago5 watchersCompare

[ Source](https://github.com/omneo/omneo-php)[ Packagist](https://packagist.org/packages/omneo/omneo-php)[ RSS](/packages/omneo-omneo-php/feed)WikiDiscussions master Synced today

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

[![](logo.png)](logo.png)

[![GitHub release](https://camo.githubusercontent.com/ced6f85ed277fcc4c5c4081e134edb48a11d964933bcfcfb71ee020d78ee45f0/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f72656c656173652f6f6d6e656f2f6f6d6e656f2d7068702e737667)](https://camo.githubusercontent.com/ced6f85ed277fcc4c5c4081e134edb48a11d964933bcfcfb71ee020d78ee45f0/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f72656c656173652f6f6d6e656f2f6f6d6e656f2d7068702e737667) [ ![Codeship Status for omneo/omneo-php](https://camo.githubusercontent.com/aa0c050efc883225755a08caa9f1652c8e4f90d2c2cdabe972e16246fbb02930/68747470733a2f2f6170702e636f6465736869702e636f6d2f70726f6a656374732f38323761353432302d326536642d303133362d646464302d3461383935303033306236652f7374617475733f6272616e63683d6d6173746572)](https://app.codeship.com/projects/288229)

Omneo PHP is a PHP client library for the Omneo API service. It allows developers to easily integrate Omneo with their PHP applications.

[Read the documentation ⟶](https://github.com/omneo/omneo-php/wiki)

- [Prerequisites](#prerequisites)
- [Quickstart](#quickstart)
- [Contributing](#contributing)

Prerequisites
-------------

[](#prerequisites)

Before being able to use the package, you will need to get your hands on the following.

- **Omneo domain** - This takes the form of `example.omneoapp.io` and is where your Omneo installation lives. If you login to your dashboard at `foo.dashboard.omneo.io`, your Omneo domain is `foo.omneoapp.io`.
- **Omneo token** - This is the secure token which identifies you to the API. It can be generated from the Omneo dashboard and is associated with your user account. It is advisable that you create a separate Omneo user specifically for your integration.
- **Shared secret** - You only need this if you plan on accepting incoming webhook and target requests from Omneo. If so, you will need to validate that it's actually Omneo sending the request by generating and comparing a signature using the shared secret.

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

[](#installation)

Installation is performed via [Composer](https://getcomposer.org/).

```
composer require omneo/omneo-php

```

Quickstart
----------

[](#quickstart)

### Plain PHP

[](#plain-php)

```
// Get credentials, you should store these outside of your codebase
$domain = 'foo.omneoapp.io';
$token = '...';
​
// Instantiate the Omneo client
$omneo = new Omneo\Client($domain, $token);
​
// Optional, add the shared secret for verifying webhooks and targets
$omneo->setSecret('horsebatterystaple');
​
// Use the client to communicate with omneo
$profiles = $omneo->profiles()->browse();
```

### Laravel

[](#laravel)

> This package utilises Laravel [Package Discovery](https://laravel.com/docs/5.6/packages#package-discovery) which means you do not need to register any service providers after installation, just type hint and go!

This package comes batteries-included for usage with Laravel. To begin, install the package using Composer and update the following files.

##### config/services.php

[](#configservicesphp)

```
'omneo' => [
    'domain' => env('OMNEO_DOMAIN'),
    'token' => env('OMNEO_TOKEN'),
    'secret' => env('OMNEO_SECRET')
]
```

##### .env

[](#env)

```
OMNEO_DOMAIN=
OMNEO_TOKEN=
OMNEO_SECRET=
```

Now that you're authentication details are set, you can utilise the Omneo package anywhere in your application that has access to the [Service Container](https://laravel.com/docs/5.6/container).

```
class FooController extends Controller
{
    public function getProfiles(Omneo\Client $omneo)
    {
        // Using typehints
        $profiles = $omneo->profiles()->browse();

        // Using the app() method
        $profiles = app(Omneo\Client::class)->profiles()->browse();
    }
}
```

Contributing
------------

[](#contributing)

To contribute to this package, please open a [Pull Request](https://github.com/omneo/omneo-php/pulls).

### Testing

[](#testing)

Testing is handled by [phpunit](https://phpunit.de). Pull requests should include unit tests for the affected logic.

```
phpunit

```

###  Health Score

35

—

LowBetter than 77% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity26

Limited adoption so far

Community18

Small or concentrated contributor base

Maturity64

Established project with proven stability

 Bus Factor3

3 contributors hold 50%+ of commits

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 ~126 days

Recently: every ~437 days

Total

17

Last Release

959d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/31e1b2b983f08ec37e2eb1cac5431b4df3d5ee19c982e11de838110edca2c908?d=identicon)[Omneo](/maintainers/Omneo)

---

Top Contributors

[![EmilyArkade](https://avatars.githubusercontent.com/u/31027069?v=4)](https://github.com/EmilyArkade "EmilyArkade (12 commits)")[![dangreaves](https://avatars.githubusercontent.com/u/1036142?v=4)](https://github.com/dangreaves "dangreaves (10 commits)")[![AndyJohnstonArkade](https://avatars.githubusercontent.com/u/31529835?v=4)](https://github.com/AndyJohnstonArkade "AndyJohnstonArkade (8 commits)")[![drwmrrs](https://avatars.githubusercontent.com/u/714448?v=4)](https://github.com/drwmrrs "drwmrrs (6 commits)")[![shane-arkade](https://avatars.githubusercontent.com/u/18390767?v=4)](https://github.com/shane-arkade "shane-arkade (3 commits)")[![lukeomneo](https://avatars.githubusercontent.com/u/69188278?v=4)](https://github.com/lukeomneo "lukeomneo (2 commits)")[![tejaspatel2014](https://avatars.githubusercontent.com/u/6571086?v=4)](https://github.com/tejaspatel2014 "tejaspatel2014 (1 commits)")[![michael-arkade](https://avatars.githubusercontent.com/u/34013244?v=4)](https://github.com/michael-arkade "michael-arkade (1 commits)")[![michael-k-arkade](https://avatars.githubusercontent.com/u/38480199?v=4)](https://github.com/michael-k-arkade "michael-k-arkade (1 commits)")[![richardsteers](https://avatars.githubusercontent.com/u/13160627?v=4)](https://github.com/richardsteers "richardsteers (1 commits)")

---

Tags

omneophp

###  Code Quality

TestsPHPUnit

### Embed Badge

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

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

###  Alternatives

[statamic/cms

The Statamic CMS Core Package

4.8k3.5M923](/packages/statamic-cms)[spatie/laravel-export

Create a static site bundle from a Laravel app

672139.5k6](/packages/spatie-laravel-export)[moonshine/moonshine

Laravel administration panel

1.3k239.9k76](/packages/moonshine-moonshine)[tencentcloud/tencentcloud-sdk-php

TencentCloudApi php sdk

3661.2M46](/packages/tencentcloud-tencentcloud-sdk-php)[smodav/mpesa

M-Pesa API implementation

16167.1k1](/packages/smodav-mpesa)[simplestats-io/laravel-client

Analytics for Laravel. Track visitors, registrations, and payments. Discover which channels actually drive revenue, not just traffic. Server-side, GDPR compliant, ad-blocker proof.

5019.3k](/packages/simplestats-io-laravel-client)

PHPackages © 2026

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