README

This package provides an integration layer with CustomerIO. You can track various events for both anonymous and identified visitors to your site via various means.

A Laravel Integration Layer for CustomerIO
Table of Contents
Support us
Installation
Usage
Testing
Changelog
Contributing
Security Vulnerabilities
Credits
License

Support us

We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.

Installation

You can install the package via composer:

composer require dominion-solutions/customerio

You can publish the config file with:

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

This is the contents of the published config file:

return [
    'api-key' => env('CUSTOMER_IO_API_KEY', 'NOT_SET'),
    'region' => env('CUSTOMER_IO_REGION', 'US'),
    'version' => env('CUSTOMER_IO_VERSION', 'v1'),
];

Usage

Identifying an Anonymous User

$anonymousUser = new CIOUser(
    anonymousId: $request->session()->getId(),
    additionalFields: [
        // Additional Fields
    ],
    traits: [
        // Traits here.
    ]
);
$result = DominionSolutions\CustomerIO\Facade\CustomerIO::upsertUser(
    $anonymousUser,
    // If you need to inject an API Key here
    apiKey: $apiKey
);
//Do something with your result.

Identifying a Known User

    userId: $request->email,
    traits: [
        'email' => $request->email,
        //Add your traits here
    ]);
$result = DominionSolutions\CustomerIO\Facade\CustomerIO::upsertUser(
    $identifyUser,
    // If you need to inject an API Key here
    apiKey: $apiKey
);
//Do something with your result.

Tracking Events for an Unknown User

$trackingEvent = new TrackingEvent(
    $request->session()->getId(),
    event: 'your-event-name',
    properties: [
        // Your Event's Properties
    ],
    additionalFields: [
        // Additional Fields
    ],
    context: [
        'active' => true,
        // More Context Fields
    ]);

$result = DominionSolutions\CustomerIO\Facade\CustomerIO::trackEvent(
    $trackingEvent,
    // If you need to inject an API Key here
    apiKey: $apiKey
);
//Do something with your result.

Tracking Events for a Known User

$trackingEvent = new TrackingEvent(
    $request->email,
    event: 'your-event-name',
    properties: [
        // Your Event's Properties
    ],
    additionalFields: [
        // Additional Fields
    ],
    context: [
        'active' => true,
        // More Context Fields
    ]);

$result = DominionSolutions\CustomerIO\Facade\CustomerIO::trackEvent(
    $trackingEvent,
    // If you need to inject an API Key here
    apiKey: $apiKey
);
//Do something with your result.

Merging Users

$response = CustomerIO::mergeUsers(
    $previousId,
    $userId,
    //If you need to inject an API Key here.
    apiKey: $apiKey
);
// Do something with your response.

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.

dominion-solutions / customerio

Maintainers

Details