PHPackages                             kaufmanndigital/cleverreach - 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. kaufmanndigital/cleverreach

ActiveNeos-package[API Development](/categories/api)

kaufmanndigital/cleverreach
===========================

An easy-to-use package that integrates CleverReach(R) into your Neos website

4.0.0(3mo ago)524.0k—3.5%8[5 issues](https://github.com/KaufmannDigital/CleverReach/issues)1GPL-3.0-or-laterPHP

Since Sep 5Pushed 3mo ago2 watchersCompare

[ Source](https://github.com/KaufmannDigital/CleverReach)[ Packagist](https://packagist.org/packages/kaufmanndigital/cleverreach)[ Docs](https://www.kaufmann.digital)[ RSS](/packages/kaufmanndigital-cleverreach/feed)WikiDiscussions master Synced today

READMEChangelog (10)Dependencies (4)Versions (36)Used By (1)

KaufmannDigital.CleverReach
===========================

[](#kaufmanndigitalcleverreach)

An easy-to-use package, that integrates the email marketing solution [CleverReach](https://www.cleverreach.com)® into your [Neos](https://www.neos.io) site to directly add new subscribers to your newsletter lists via registration form.

Version Compatibility
---------------------

[](#version-compatibility)

Package versionNeos version**4.x**Neos 9.x**3.x**Neos 7.x / 8.xInstallation
------------

[](#installation)

The easiest way to install is running this command:

**For Neos 9.x:**

```
composer require kaufmanndigital/cleverreach:^4.0
```

**For Neos 7.x / 8.x:**

```
composer require kaufmanndigital/cleverreach:^3.0
```

**After successful installation, configure your CleverReach® credentials with oAuth-credentials:**

You can create such credentials at  (Menu "My Account" -&gt; "REST API"). **You need credentials for REST API V3.**

```
KaufmannDigital:
  CleverReach:
    credentials:
      clientId: ''
      clientSecret: ''
```

**Alternative:** Instead of configuring credentials in `Settings.yaml`, you can add the `KaufmannDigital.CleverReach:Mixin.NodeWithCleverReachCredentials` mixin to any NodeType (e.g. your site node). This adds **Client ID** and **Client Secret** fields to the Neos inspector, allowing editors to manage credentials directly in the backend. Node-based credentials take precedence over `Settings.yaml`.

**Optional:** If you want to use Ajax submitting your forms, please load the shipped JavaScript (jQuery needed) using `` inside your template or create your own Ajax-action.

*Congratulations, you are ready to use **KaufmannDigital.CleverReach** in your Neos installation.*

Setting up the Registration Form
--------------------------------

[](#setting-up-the-registration-form)

In order to add a Registration Form to your Website, you have to **create a group** (and a form, if your want to use [DOI](https://www.cleverreach.com/de/funktionen/empfaenger-verwalten/doi-anmeldeformulare/))
Currently these steps can not be done by this package (see Planned Features). So please go to your [CleverReach Login](https://www.cleverreach.com/de/login/) and follow the instructions there.

When you finished, login into your Neos and navigate to the page, you want to place the registration form on.
Now select the "CleverReach Registration Form" NodeType from the list and insert it where you want.

Afterwards you can select the group, users would be added to and form which should be used for Double-Opt-In (if activated):
[![Screenshot inspector](Documentation/Images/screenshot_inspector.png "Inspector of Registration Form NodeType")](Documentation/Images/screenshot_inspector.png)

You are mostly finished. Just give it a try: Register your E-Mail using the Neos frontend and check at CleverReach's customer area.

Additional Fields
-----------------

[](#additional-fields)

CleverReach® supports additional fields to store more information about the subscriber. [Take a look here](https://support.cleverreach.de/hc/de/articles/202372851-Nutzung-eigener-Datenfelder-in-Empf%C3%A4ngerlisten)
These fields are also supported by this package. To submit data to this fields, you have to do a bit of customizing:

1. Create the additional fields at CleverReach®. [Described here](https://support.cleverreach.de/hc/de/articles/202372851-Nutzung-eigener-Datenfelder-in-Empf%C3%A4ngerlisten)
2. Override the template of NodeType [Explained in Documentation](http://flowframework.readthedocs.io/en/stable/TheDefinitiveGuide/PartIII/ModelViewController.html#configuring-views-through-views-yaml) like this

    ```
    -
     requestFilter: 'isPackage("KaufmannDigital.CleverReach")'
     options:
       templateRootPaths:
         'KaufmannDigital.CleverReach': 'resource://Your.Package/Private/Templates/'
    ```
3. Add your custom fields as input field to your customized template:

    ```

    ```

    or as hidden field:

    ```

    ```

    For **global additional fields** just replace `attributes` with `global_attributes`

Orders
------

[](#orders)

CleverReach® also allows you to supply order information with the new subscriber.
To do that you have to override the template as explained above in step 2 of **Additional Fields**Then you can add something like that to the form:

```

```

Configuring Views through Views.yaml
------------------------------------

[](#configuring-views-through-viewsyaml)

If you want to override the package templates in your site package, you can create a `Views.yaml` in your configuration folder.

```
-
  requestFilter: 'isPackage("KaufmannDigital.CleverReach") && isController("Subscription") && isAction("index")'
  options:
    templatePathAndFilename: 'resource://My.Package/Private/Templates/.../Index.html'
-
  requestFilter: 'isPackage("KaufmannDigital.CleverReach") && isController("Subscription") && isAction("subscribe")'
  options:
    templatePathAndFilename: 'resource://My.Package/Private/Templates/.../Subscribe.html'
```

FAQ
---

[](#faq)

- I get an error `CleverReach authentication failed. Credentials correct?`
    - Make sure the credentials you have configured in `Settings.yaml` are correct. To be sure, copy the credentials and try to log into CleverReach's website with it.

Known Bugs
----------

[](#known-bugs)

Known Bugs are submitted as issue. Please have a look at it, before you supply a bug you found.
You did a bugfix? Great! Please submit it as PR to share it with other users.

Planned Features
----------------

[](#planned-features)

Planned functions are also created as issues and marked as such.
You have another idea? Or would you like to help with the implementation? Gladly! Simply create new issues or PRs.

Maintainer
----------

[](#maintainer)

This package is maintained by [Kaufmann Digital](https://www.kaufmann.digital).
Feel free to send us your questions or requests to

License
-------

[](#license)

Licensed under GPLv3+, see [LICENSE](LICENSE)

###  Health Score

52

—

FairBetter than 96% of packages

Maintenance60

Regular maintenance activity

Popularity35

Limited adoption so far

Community25

Small or concentrated contributor base

Maturity75

Established project with proven stability

 Bus Factor1

Top contributor holds 55.9% 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.

###  Release Activity

Cadence

Every ~100 days

Total

32

Last Release

106d ago

Major Versions

1.2.2 → 2.0.02019-10-09

2.1.0 → 3.0.02021-04-09

2.1.1 → 3.1.32022-05-25

2.1.2 → 3.2.02025-01-28

3.3.1 → 4.0.02026-03-16

### Community

Maintainers

![](https://www.gravatar.com/avatar/1ec6c2ae665e40ee04396a70c824f37be27b5f98330b66c18256ebd21dfb52b5?d=identicon)[kaufmanndigital](/maintainers/kaufmanndigital)

---

Top Contributors

[![Nikdro](https://avatars.githubusercontent.com/u/9807101?v=4)](https://github.com/Nikdro "Nikdro (33 commits)")[![Andyyyyyy](https://avatars.githubusercontent.com/u/18618394?v=4)](https://github.com/Andyyyyyy "Andyyyyyy (7 commits)")[![daniellienert](https://avatars.githubusercontent.com/u/642226?v=4)](https://github.com/daniellienert "daniellienert (5 commits)")[![andrehoffmann30](https://avatars.githubusercontent.com/u/23524251?v=4)](https://github.com/andrehoffmann30 "andrehoffmann30 (5 commits)")[![mirkokaufmann](https://avatars.githubusercontent.com/u/2813269?v=4)](https://github.com/mirkokaufmann "mirkokaufmann (2 commits)")[![bastianjoel](https://avatars.githubusercontent.com/u/9317999?v=4)](https://github.com/bastianjoel "bastianjoel (2 commits)")[![ursulaklinger](https://avatars.githubusercontent.com/u/10496335?v=4)](https://github.com/ursulaklinger "ursulaklinger (1 commits)")[![c4ll-m3-j4ck](https://avatars.githubusercontent.com/u/7119811?v=4)](https://github.com/c4ll-m3-j4ck "c4ll-m3-j4ck (1 commits)")[![jobee](https://avatars.githubusercontent.com/u/5636715?v=4)](https://github.com/jobee "jobee (1 commits)")[![mberhorst](https://avatars.githubusercontent.com/u/2861236?v=4)](https://github.com/mberhorst "mberhorst (1 commits)")[![rolandschuetz](https://avatars.githubusercontent.com/u/735982?v=4)](https://github.com/rolandschuetz "rolandschuetz (1 commits)")

---

Tags

hacktoberfest

### Embed Badge

![Health badge](/badges/kaufmanndigital-cleverreach/health.svg)

```
[![Health](https://phpackages.com/badges/kaufmanndigital-cleverreach/health.svg)](https://phpackages.com/packages/kaufmanndigital-cleverreach)
```

###  Alternatives

[statamic/cms

The Statamic CMS Core Package

4.8k3.6M987](/packages/statamic-cms)[tencentcloud/tencentcloud-sdk-php

TencentCloudApi php sdk

3741.3M45](/packages/tencentcloud-tencentcloud-sdk-php)[neuron-core/neuron-ai

The PHP Agentic Framework.

2.0k656.1k38](/packages/neuron-core-neuron-ai)[eslazarev/wildberries-sdk

Wildberries OpenAPI clients (generated).

273.0k](/packages/eslazarev-wildberries-sdk)[avalara/avataxclient

Client library for Avalara's AvaTax suite of business tax calculation and processing services. Uses the REST v2 API.

528.5M7](/packages/avalara-avataxclient)[files.com/files-php-sdk

Files.com PHP SDK

2481.1k](/packages/filescom-files-php-sdk)

PHPackages © 2026

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