README

Overview

Module integrates Magento with Channels service. It allows synchronizing Magento customer accounts into Channels contacts.

Compatibility

Magento >= 2.3
Supports both Magento Open Source (Community) and Magento Commerce (Enterprise)

Installation Instructions

Install extension using composer by using commands:

composer require channels/module-channels --no-update
composer update channels/module-channels
bin/magento setup:upgrade
bin/magento cache:flush

Configuration

To integrate module with the service:

Log in to Magento 2 backend
Navigate to Stores -> Configuration
Navigate to Services -> Channels App tab
Enable integration, fill API details
Save

API account and API key can be found in Channels backend in "Integrations" tab.

Scheduling existing customers

CLI

Module provides a command to schedule existing customers for export. It can be used when module is integrated in store which already have customers. To do so, run a command:

bin/magento channels:customer:export

Admin interface

It's also possible to schedule multiple customers for Channels export directly in the admin interface.

In order to do this, navigate to customer grid, select customers and use "Export to Channels" mass action.

Note that recommended way is CLI, especially if store contains significant number of customers.

Technical approach

Customer account synchronization is scheduled to queue on each account or address change. Queue is configured to use database by default, however it can be adjusted to use RabbitMQ or any other queue backend supported by Magento.

By default, Magento processes database queue on CRON basis. CRON job runs once per minute, executes queue messages and sends scheduled contacts to the service.

To start queue processing manually:

bin/magento queue:consumers:start channelsCustomerExport --max-messages=1

channels / module-channels

Maintainers

Details