PHPackages                             notifymehq/notifyme - 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. [Mail & Notifications](/categories/mail)
4. /
5. notifymehq/notifyme

AbandonedArchivedLibrary[Mail & Notifications](/categories/mail)

notifymehq/notifyme
===================

Provides a common interface for notification services

1644.4k11PHP

Since Dec 11Pushed 8y ago12 watchersCompare

[ Source](https://github.com/NotifyMeHQ/notifyme)[ Packagist](https://packagist.org/packages/notifymehq/notifyme)[ RSS](/packages/notifymehq-notifyme/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependenciesVersions (2)Used By (0)

NotifyMe
========

[](#notifyme)

[![StyleCI](https://camo.githubusercontent.com/ce65a225ad4e8c9f299e718b07ad0b2c48e506b922434231ee7760255fd435f4/68747470733a2f2f7374796c6563692e696f2f7265706f732f32393035333233362f736869656c64)](https://styleci.io/repos/29053236)[![Build Status](https://camo.githubusercontent.com/c115d96e9880b336feec15a566d7ebdea8b1c1700b551dfe77abe64b0a4742af/68747470733a2f2f696d672e736869656c64732e696f2f7472617669732f6e6f746966796d6568712f6e6f746966796d652e7376673f7374796c653d666c61742d737175617265)](https://travis-ci.org/notifymehq/notifyme)

Common interface for notification services.

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

[](#installation)

Either [PHP](https://php.net) 5.5+ or [HHVM](http://hhvm.com) 3.6+ are required.

To get the latest version of NotifyMe, simply require the project using [Composer](https://getcomposer.org):

```
$ composer require notifymehq/notifyme
```

Instead, you may of course manually update your require block and run `composer update` if you so choose:

```
{
    "require": {
        "notifymehq/notifyme": "^1.0"
    }
}
```

If you want, you can require only a single adapter. This works rather like the component system of laravel or symfony. We currently have the following adapters:

- Ballou (`notifymehq/ballou`)
- Campfire (`notifymehq/campfire`)
- Gitter (`notifymehq/gitter`)
- Hipchat (`notifymehq/hipchat`)
- Pagerduty (`notifymehq/pagerduty`)
- Pushover (`notifymehq/pushover`)
- Slack (`notifymehq/slack`)
- Twilio (`notifymehq/twilio`)
- Webhook (`notifymehq/webhook`)
- Yo (`notifymehq/yo`)

Also, note, that our other components are:

- Contracts (`notifymehq/contracts`)
- Factory (`notifymehq/factory`)
- Http (`notifymehq/http`)
- Manager (`notifymehq/manager`)
- Support (`notifymehq/support`)

Finally, we have a totally seperate Laravel bridge available for use by installing `notifyme/laravel`, then adding our service provider: `NotifyMeHQ\Laravel\NotifyMeServiceProvider`.

Usage
-----

[](#usage)

- Create a factory : `$factory = new NotifyMeHQ\Factory\NotifyMeFactory();`
- Make a notifier : `$notifier = $factory->make($config);`
- Notify : `$response = $notifier->notify($to, $message);`
- Check the response : `$response->isSent();`

Example
-------

[](#example)

Here is an example of a notification with Slack:

```