Download the PHP package engageso/engage-php without Composer
On this page you can find all versions of the php package engageso/engage-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download engageso/engage-php
More information about engageso/engage-php
Files in engageso/engage-php
Package engage-php
Short Description A PHP SDK for Engage (http://engage.so/)
License MIT
Homepage https://engage.so/
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package engage-php
Engage PHP SDK
The Engage PHP SDK lets you capture user attributes and events on your site. You can later use this on Engage to create user segments for analytics, broadcast messages and automation messages.
Getting Started
Create an Engage account to get your API key
Installation
Configuration
Initialise the SDK with your public and private key. Your keys are available in the settings page of your Engage dashboard.
Identifying users
You only need a unique identifier that represents the user on your platform to track their events and attributes on Engage. To correlate a proper profile to these tracked attributes and events, you can send the unique identifier and other properties to Engage. You only need to do this once per user, probably at user signup.
id represents the unique identifier for the user on your platform. It is the only required parameter. You can send any other attribute you want e.g. age, plan. Here are the standard ones we use internally on the user profile:
first_namelast_nameemailis_account(if the user is an account or customer)number(with international dialing code without the +)created_at(represents when the user registered on your platform. If not added, Engage sets it to the current timestamp.)
To identify a user as an Account:
To convert a Customer to an Account:
To convert an Account to a Customer:
Update/add user attributes
If you need to add new attributes or update an existing attribute, you can use the addAttribute method.
(You can also use identify to update or add new attributes.)
Tracking user events and actions
You can track user events and actions in a couple of ways.
Tracking an event with no value:
Tracking an event with a value:
event is the event you want to track. value is the value of the event. This can be a string, number or boolean. There is an optional timestamp parameter. If not included, Engage uses the current timestamp. The timestamp value must be a valid datetime string.
If you need to track more properties with the event, you can track it this way:
Add a Customer to an Account
Role is optional.
Update Account role
Remove Customer from Account
License
MIT
