PHPackages                             frain/convoy - 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. frain/convoy

ActiveLibrary[API Development](/categories/api)

frain/convoy
============

Convoy PHP SDK Library

v1.0.1(3y ago)21.6kMITPHPPHP ^7.3 || ^8.0

Since Mar 11Pushed 3y ago3 watchersCompare

[ Source](https://github.com/frain-dev/convoy-php)[ Packagist](https://packagist.org/packages/frain/convoy)[ Docs](https://github.com/frain/convoy)[ RSS](/packages/frain-convoy/feed)WikiDiscussions main Synced 3w ago

READMEChangelog (4)Dependencies (9)Versions (5)Used By (0)

Convoy SDK for PHP
==================

[](#convoy-sdk-for-php)

[![Latest Version on Packagist](https://camo.githubusercontent.com/ee5ab903e08604e83c28fded2d73a9bac57ac8de9b68a6805bedfea5785aacf1/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f667261696e2f636f6e766f792e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/frain/convoy)[![Total Downloads](https://camo.githubusercontent.com/37dd95ccbf6c02f715580c2946699789830c72a9e1b20a57e4b39177739bc161/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f667261696e2f636f6e766f792e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/frain/convoy)

This is the Convoy PHP SDK. This SDK contains methods for easily interacting with Convoy's API. Below are examples to get you started. For additional examples, please see our official documentation at ()

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

[](#installation)

To install the package, you will need to be using Composer in your project.

The Convoy PHP SDK is not hard coupled to any HTTP Client such as Guzzle or any other library used to make HTTP requests. The HTTP Client implementation is based on [PSR-18](https://www.php-fig.org/psr/psr-18/). This provides you with the convenience of choosing what [PSR-7](https://packagist.org/providers/psr/http-message-implementation) and [HTTP Client](https://packagist.org/providers/psr/http-client-implementation) you want to use.

To get started quickly,

```
composer require frain/convoy symfony/http-client nyholm/psr7
```

### Setup Client

[](#setup-client)

Next, import the `convoy` module and setup with your auth credentials.

```
use Convoy\Convoy;

$convoy = new Convoy(["api_key" => "your_api_key", "project_id" => "your_project_id"]);
```

### Create an Endpoint

[](#create-an-endpoint)

An endpoint represents a target URL to receive events.

```
$endpointData = [
    "name" => "Default Endpoint",
    "url" => "https://0d87-102-89-2-172.ngrok.io",
    "description" => "Default Endpoint",
    "secret" => "endpoint-secret",
    "events" => ["*"]
];

$response = $convoy->endpoints()->create($endpointData);
```

### Update an Endpoint

[](#update-an-endpoint)

```
$endpointId = "01GTVFSGBAH8NJTMT5Y1ENE218";

$endpointData = [
    "name" => "Default Endpoint",
    "url" => "https://0d87-102-89-2-172.ngrok.io",
    "description" => "Default Endpoint",
    "secret" => "endpoint-secret",
    "events" => ["*"]
];

$response = $convoy->endpoints()->update($endpointId, $endpointData);
```

### Sending an Event

[](#sending-an-event)

To send an event, you'll need the `uid` from the endpoint we created earlier.

```
$eventData = [
    "endpoint_id" => $endpointId,
    "event_type" => "payment.success",
    "data" => [
        "event" => "payment.success",
        "data" => [
            "status" => "Completed",
            "description" => "Transaction Successful",
            "userID" => "test_user_id808"
        ]
    ]
];

$response = $convoy->events()->create($eventData);
```

Testing
-------

[](#testing)

```
composer test
```

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

[](#contributing)

Please see [CONTRIBUTING](CONTRIBUTING.md) for details.

Credits
-------

[](#credits)

- [Frain](https://github.com/frain-dev)

License
-------

[](#license)

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

###  Health Score

30

—

LowBetter than 62% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity22

Limited adoption so far

Community11

Small or concentrated contributor base

Maturity57

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 91.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 ~101 days

Total

4

Last Release

1260d ago

Major Versions

v0.1.1 → v1.0.02022-12-01

### Community

Maintainers

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

---

Top Contributors

[![Dotunj](https://avatars.githubusercontent.com/u/11479249?v=4)](https://github.com/Dotunj "Dotunj (21 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (1 commits)")[![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4)](https://github.com/github-actions[bot] "github-actions[bot] (1 commits)")

---

Tags

webhooksfrainconvoy

###  Code Quality

TestsPest

Code StylePHP CS Fixer

### Embed Badge

![Health badge](/badges/frain-convoy/health.svg)

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

###  Alternatives

[telnyx/telnyx-php

Official Telnyx PHP SDK — APIs for Voice, SMS, MMS, WhatsApp, Fax, SIP Trunking, Wireless IoT, Call Control, and more. Build global communications on Telnyx's private carrier-grade network.

35729.6k2](/packages/telnyx-telnyx-php)[getbrevo/brevo-php

Official Brevo provided RESTFul API V3 php library

1003.6M46](/packages/getbrevo-brevo-php)[jane-php/jane-php

All jane libraries into one repository

683267.5k5](/packages/jane-php-jane-php)[php-tmdb/api

PHP wrapper for TMDB (TheMovieDatabase) API v3. Supports two types of approaches, one modelled with repositories, models and factories. And the other by simple array access to RAW data from The Movie Database.

427382.4k17](/packages/php-tmdb-api)[phpro/http-tools

HTTP tools for developing more consistent HTTP implementations.

28146.3k](/packages/phpro-http-tools)[n1ebieski/ksef-php-client

PHP API client that allows you to interact with the API Krajowego Systemu e-Faktur

8754.6k](/packages/n1ebieski-ksef-php-client)

PHPackages © 2026

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