PHPackages                             do-it-well/magento2-module-referralcandy - 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. [Utility &amp; Helpers](/categories/utility)
4. /
5. do-it-well/magento2-module-referralcandy

ActiveMagento2-module[Utility &amp; Helpers](/categories/utility)

do-it-well/magento2-module-referralcandy
========================================

Integration with Referral Candy

079PHP

Since Feb 4Pushed 7y ago1 watchersCompare

[ Source](https://github.com/do-it-well/magento2-module-referralcandy)[ Packagist](https://packagist.org/packages/do-it-well/magento2-module-referralcandy)[ RSS](/packages/do-it-well-magento2-module-referralcandy/feed)WikiDiscussions master Synced 2w ago

READMEChangelogDependenciesVersions (1)Used By (0)

ReferralCandy Integration for Magento2
======================================

[](#referralcandy-integration-for-magento2)

A Magento2 Module providing integration with [Referral Candy](https://www.referralcandy.com/).

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

[](#installation)

This module can be installed via composer and the Magento2 command-line tool. For example:

```
composer require do-it-well/magento2-module-referralcandy
./bin/magento module:enable DIW_ReferralCandy
./bin/magento setup:upgrade

```

Configuration
-------------

[](#configuration)

By default, the module will be "enabled", but inactive. The module will not output anything to your site until it has been configured. You will need to fill out the "Connection Type", and the relevant options for the selected type. The values for the "Email" type can be found under the "Integration" section of your Referral Candy account, while the values for the "JavaScript" type can be found under the "Plugin tokens" sections of your Referral Candy account profile.

Module configuration can be found under the Magento2 Admin Panel, in the section:

**Stores** &gt; **Settings** &gt; **Configuration** &gt; **Sales** &gt; **Referral Candy** &gt; **Tracking**

Configuration options are:

OptionDescriptionDefaultEnableAllows module output to be completely toggled on/offYesConnection TypeThe type of connection to ReferralCandy, from the "Integration" section of your account.EmailApp ID(only for "JavaScript" connections) Identifier for your Referral Candy account.(none)Secret Key(only for "JavaScript" connections) The Secret Key for your Referral Candy account.(none)Forward or BCC your invoices to this email(only for "Email" connections) Email Address to send a copy of Invoice Emails to.(none)Note that the "Forward or BCC your invoices to this email" option is dependent on the "Send Invoice Email Copy Method" option under:

**Stores** &gt; **Settings** &gt; **Configuration** &gt; **Sales** &gt; **Sales Emails** &gt; **Invoice**

This option defaults to "Bcc", which is correct for Referral Candy. The email copy will not be sent unless both options are set correctly.

License
-------

[](#license)

All module code within this repository is licensed under the MIT license. See the LICENSE.md file for details.

Do It Well Limited is not in any way affiliated with Referral Candy. This module has been developed independently, without any direction or explicit or implicit endorsement or vetting on the part of those services to which it attempts to integrate.

Support
-------

[](#support)

If you encounter any problems with this module, you may open an issue on GitHub at

Premium support, assistance in module installation or configuration, or other development services, can be obtained by contacting [Do It Well Limited](https://do-it-well.co.uk/)

###  Health Score

20

—

LowBetter than 13% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity9

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity39

Early-stage or recently created project

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

### Community

Maintainers

![](https://www.gravatar.com/avatar/6b8e2fa6face61daa12caeebb903a743d55f1ae1a8b1a27ac261a0b609b10908?d=identicon)[do-it-well](/maintainers/do-it-well)

---

Top Contributors

[![wpalmer](https://avatars.githubusercontent.com/u/357044?v=4)](https://github.com/wpalmer "wpalmer (3 commits)")

### Embed Badge

![Health badge](/badges/do-it-well-magento2-module-referralcandy/health.svg)

```
[![Health](https://phpackages.com/badges/do-it-well-magento2-module-referralcandy/health.svg)](https://phpackages.com/packages/do-it-well-magento2-module-referralcandy)
```

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
