This library helps with integrating Userlist.io into PHP applications.
This library can be installed via Composer:
composer require userlistio/userlist
The only required configuration is the Push API key. You can get your Push API key via the Push API settings in your Userlist.io account.
Configuration values can be set when creating a new push client or via environment variables. The environment takes precedence over values provided during the initialization process.
Configuration via environment variables
Configuration during initialization
$userlist = new \Userlist\Push(['push_key' => '401e5c498be718c0a38b7da7f1ce5b409c56132a49246c435ee296e07bf2be39']);
Before tracking user or event data, create a new push client. If you configured your push key via environment variables there's nothing to add. Otherwise, see the example above.
$userlist = new \Userlist\Push();
$userlist->user([ 'identifier' => 'user-1', 'email' => 'firstname.lastname@example.org', 'properties' => [ 'first_name' => 'Jane', 'last_name' => 'Doe' ] ]);
$userlist = new \Userlist\Push(); $userlist->event([ 'name' => 'project_created', 'user' => 'user-1', 'properties' => [ 'name' => 'Example Project', ] ]);
Bug reports and pull requests are welcome on GitHub at https://github.com/userlistio/userlist-php. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
The library is available as open source under the terms of the MIT License.
Code of Conduct
Everyone interacting in the Userlist project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.