PHPackages                             kustomer/kustomer-integration - 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. [API Development](/categories/api)
4. /
5. kustomer/kustomer-integration

ActiveMagento2-module[API Development](/categories/api)

kustomer/kustomer-integration
=============================

Integrate Magento eCommerce site with Kustomer service

1.1.11(3y ago)214.7k6OSL-3.0PHPPHP ~5.5.0|~5.6.0|~7.0.0|~7.1.0 |~7.2.0|~7.3.0|~7.4.0CI passing

Since Mar 30Pushed 9mo ago34 watchersCompare

[ Source](https://github.com/kustomer/magento)[ Packagist](https://packagist.org/packages/kustomer/kustomer-integration)[ RSS](/packages/kustomer-kustomer-integration/feed)WikiDiscussions master Synced 2mo ago

READMEChangelog (10)Dependencies (1)Versions (25)Used By (0)

Kustomer Extension for Adobe Commerce 2.x
=========================================

[](#kustomer-extension-for-adobe-commerce-2x)

This extension allows publication of Adobe Commerce events to Kustomer. It provides a `KustomerEventObserver` class that you can extend to publish events to your Kustomer account.

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

[](#installation)

1. `$ composer require kustomer/kustomer-integration` from your Adobe Commerce project root
2. `$ bin/magento module:enable Kustomer_KustomerIntegration --clear-static-content`
3. `$ bin/magento setup:upgrade`
4. `$ bin/magento setup:di:compile`

### Notes

[](#notes)

#### Packagist

[](#packagist)

If you are using the default adobe commerce metapackage, you will need to add the packagist repo to your store's `composer.json`:

```
{
    "repositories": [
        {
            "type": "composer",
            "url": "https://repo.magento.com/"
        },
        {
            "type": "composer",
            "url": "https://packagist.org"
        }
    ]
}
```

Find more detailed instructions [here](http://devdocs.magento.com/guides/v2.2/comp-mgr/install-extensions.html)

#### Cron

[](#cron)

The extension makes use of a cron job to collect events and send them to Kustomer and thus requires cron to be installed on the Adobe Commerce server.

You can check if the cron was installed correctly with `crontab -l`. If the cron does not show up, run `bin/magento cron:install` in your Adobe Commerce dir. [This command](https://devdocs.magento.com/guides/v2.4/config-guide/cli/config-cli-subcommands-cron.html) is available with Adobe Commerce 2.2.

### Setup

[](#setup)

Use of this extension requires an active Kustomer subscription. More information about Kustomer can be found on our [website](https://www.kustomer.com).

Before you can start sending data to Kustomer, you must install the Adobe Commerce app in your Kustomer account. You can do this by logging into the Kustomer app then go to `Settings>>App Directory` and click `Install` for Adobe Commerce.

Once Adobe Commerce is enabled on your Kustomer account, you need to create an API key so your Adobe Commerce store can send data to Kustomer. In the Kustomer app, go to `Settings>>API Keys`. Create a key here with the role `org.user` and keep a copy of the key handy. You will need it.

Next, go to your Adobe Commerce store's admin site and navigate to `Store>>Configuration>>Customers>>Kustomer` (if the `Kustomer` option is not available, see the installation instructions above). Select the store/website you want to integrate with Kustomer (or stay in the default scope if you want to use the integration globally). Enter the API key you generated in Kustomer into the API Key box and make sure the `Enabled` option is set to `Yes`. Next, select any of the default events you want to broadcast to Kustomer (such as when a new Customer is created) and click `Save`. You should be all set!

### Pausing the Extension

[](#pausing-the-extension)

If you want to stop sending data to Kustomer, you can turn off the extension at any time by returning to the settings page and setting the `Enabled` value to `No`. Note that any data collected while the extension is off will not be sent to Kustomer.

Custom Events and Objects
-------------------------

[](#custom-events-and-objects)

While the Kustomer Extension comes with a few pre-made events (new customers, orders, etc.), it is possible to send add your own custom events to Kustomer. To do this, create your own module and make sure `kustomer/kustomer-integration` is one of the requirements in `composer.json`. For more information about creating Adobe Commerce Modules, see the [Adobe Commerce Developer Documentation](http://devdocs.magento.com/guides/v2.2/extension-dev-guide/bk-extension-dev-guide.html).

Then create an Observer under `Observers/MySubscriptionObserver.php` and extend the `KustomerEventObserver` class. If you wanted to send a custom Subscription object to Kustomer when it is created, you might do something like this:

```