oscar-team/customerio-laravel

Package will be used to create customers and events on Customer.io using Laravel

2.0.3 2023-12-15 09:06 UTC

Requires

• php: >=8.0
• printu/customerio: ^3.5

MIT

• Babar Afzaal

README

Package is used to create/update customer and events for customer on Customer.io Package is using printu/customerio package.

Installtion

composer require oscar-team/customerio-laravel

You can also publish the config file with:

php artisan vendor:publish --tag=customerio-config

Generate Site ID, API Key and App API Key from Customer.io and setup variables in .env file.

CUSTOMER_IO_DEFAULT_WORKSPACE=VALUE
CUSTOMER_IO_SITE_ID=VALUE
CUSTOMER_IO_API_KEY=VALUE
CUSTOMER_IO_APP_API_KEY=VALUE

If you want to setup more workspaces to connect to, then you need to copy the add them into config/customerio.php in the workspaces key. Each workspace needs to have these 3 keys: api_key, app_api_key, site_id.

Usage

Include use Oscar\CustomerioLaravel\Facade\CustomerIo; in your controller and add following function.

Create customer.io object

$customerIo = CustomerIo::workspace();

or

$customerIo = CustomerIo::workspace('us_market');

Search Customer by Email

$isCustomer = $customerIo->searchCustomerByEmail($email);

Create Customer

email is required to create customer and id is option but cannot be null. It is possible to add more attributes you want to add for customer.

$customerData = [
    'id' => 1
    'email' => '[e-mail]',
    'first_name' => 'john',
    'last_name' => 'doe',
];
$customerIo->addCustomer($customerData);

Update Customer

email is required to create customer and id is option but cannot be null.

$customerData = [
    'id' => 1
    'email' => '[e-mail]',
    'first_name' => 'Doe',
    'last_name' => 'John',
];
$customerIo->updateCustomer($customerData);

Create Event

While creating and event, id or email is used to link the event with customer, for

$eventData = [
    'id' => 1
    'email' => '[e-mail]',
    'name' => 'Event Created',
    'data' => []
];
$customerIo->createEvent($eventData);