PHPackages                             tawk-gmbh/mautic-friendlycaptcha-bundle - 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 & Helpers](/categories/utility)
4. /
5. tawk-gmbh/mautic-friendlycaptcha-bundle

ActiveMautic-plugin[Utility & Helpers](/categories/utility)

tawk-gmbh/mautic-friendlycaptcha-bundle
=======================================

This plugin brings Friendly Captcha integration to mautic.

v5.4.10(2mo ago)41.2k↓20.8%5[1 PRs](https://github.com/TAWK-GmbH/mautic-friendlycaptcha/pulls)GPL-3.0-onlyPHPPHP >=8.1CI passing

Since Nov 7Pushed 2mo ago2 watchersCompare

[ Source](https://github.com/TAWK-GmbH/mautic-friendlycaptcha)[ Packagist](https://packagist.org/packages/tawk-gmbh/mautic-friendlycaptcha-bundle)[ RSS](/packages/tawk-gmbh-mautic-friendlycaptcha-bundle/feed)WikiDiscussions main Synced 3w ago

READMEChangelog (7)Dependencies (2)Versions (7)Used By (0)

Mautic Friendly Captcha Plugin
==============================

[](#mautic-friendly-captcha-plugin)

This plugin integrates Friendly Captcha with Mautic 5 and 6.

Friendly Captcha is a protected trademark. All Friendly Captcha trademarks, logos and brand names are the sole property of Friendly Captcha GmbH, Germany. Use of them does not imply any affiliation with or endorsement by them.

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

[](#installation)

**install via composer**

```
composer require tawk-gmbh/mautic-friendlycaptcha-bundle

```

**manual installation**Download the latests release and extract all files into a folder MauticFriendlyCaptchaBundle / rename the topmost folder (if necessary). Place the folder into the plugins directory of your Mautic installation, clear the cache and press "Install/Upgrade Plugins"

Modes
-----

[](#modes)

This plugin supports three different embedding modes, depending on your use case:

- Legacy (default)
- Automatic
- Manual

### Legacy

[](#legacy)

Legacy is the default mode after upgrading the plugin, unless you select another mode. In Legacy mode, all necessary scripts are embedded automatically, and the captcha is added after a specified delay. This mode is required when embedding forms using an *iframe*.

**Delay**

- 2-second timeout via window.setTimeout (default for legacy reasons)
- [HTMLElement: load event on script tag](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/load_event) (RECOMMENDED whenever possible)

If the Friendly Captcha SDK is not yet available in the window, the API script checks for its presence every 500ms.

**Friendly Captcha versions**

- v1: 0.9.19
- v2: 0.1.36

The Friendly Captcha challenge scripts are integrated into this plugin to help with GDPR compliance, provided Mautic is hosted and configured appropriately. This plugin does not guarantee automatic compliance. Because all scripts are loaded from your Mautic instance, you depend on the plugin maintainer and your Mautic instance provider to update the Friendly Captcha SDK to the latest version.

### Automatic

[](#automatic)

Like **Legacy** mode, the captcha is added automatically to your form. The difference is that you must embed the Friendly Captcha SDK yourself. This makes the website owner independent from the plugin maintainer and the Mautic instance provider. Please note that the library expects the following global variables: `friendlyChallenge` for [Friendly Captcha v1](https://developer.friendlycaptcha.com/docs/v1/sdk/#if-you-are-using-the-widget-script-tag) and `frcaptcha` for v2. These variables should be available when using the widget script tag. Another advantage of embedding the SDK yourself in the header before the Mautic forms load is faster captcha loading times. We recommend this mode whenever possible for security reasons. See [Links to Friendly Captcha's Getting Started](#links-to-friendly-captchas-getting-started) for instructions on embedding the scripts.

Automatic embedding is the recommended method and should work with both traditional server-side rendered applications and client-side JavaScript frameworks.

### Manual Mode

[](#manual-mode)

This mode is optimized for embedding scripts in Javascript frameworks like Next.js, Vue, or Angular. By choosing manual embed mode, you control the lifecycle of all scripts in the most efficient way. We recommend this mode if you encounter script loading issues caused by your framework or if you want to [develop your own API](#rolling-your-own-api).

You MUST embed all scripts mentioned in the [Friendly Captcha documentation](#links-to-friendly-captchas-getting-started) yourself. You will also need to embed the API used for this plugin (or roll your own), which is located at Assets/js/add-captcha.js. This means you are responsible for manually adding the API and updating the file if there are breaking changes.

When using this mode, the form pushes a captcha settings object into a globally available queue which is located in the window. You CAN call the function `displayCaptchasInForms`, passing this queue as a parameter.

```
window.FriendlyCaptchaQueue = window.FriendlyCaptchaQueue || [];
window.FriendlyCaptchaQueue.push({
    wrapperId: '{{ captchaWrapperId }}',
    inputName: '{{ inputName }}',
    siteKey: '{{ siteKey }}',
    version: '{{ version }}',
    mode: '{{ field.properties.mode }}'
});

displayCaptchasInForms(window.FriendlyCaptchaQueue);

```

NOTE: `displayCaptchasInForms` is a convenience function but you are free to develop your own api and add the catcha in the way you need. See [Rolling your own API](#rolling-your-own-api) for limitations.

#### Rolling your own API

[](#rolling-your-own-api)

Wether you import the widget as npm module and/or write your own API, Friendly Captcha expects the following HTML Elements:

- A wrapper div
- A input field as captcha solution

**wrapper id**The wrapper is created by this plugin and holds an id `'mauticform' ~ formName ~ '_' ~ id ~ '_captcha'` e.g. `mauticform_testform_mycaptchaid_captcha`; testform would be the name of your mautic form whereas mycaptchaid the html id that mautic or the form creator gave to the form field.

**captcha solution field name**This plugin expects the input field name to be set to `'mauticform[' ~ field.alias ~ ']'` whereas field.alias is the field alias defined in the mautic form field e.g. mauticform\[captcha\].

Links to Friendly Captcha Getting Started
-----------------------------------------

[](#links-to-friendly-captcha-getting-started)

- [Friendly Captcha v1](https://developer.friendlycaptcha.com/docs/v2/getting-started/install)
- [Friendly Captcha v2](https://developer.friendlycaptcha.com/docs/v1/getting-started/install)

###  Health Score

46

—

FairBetter than 92% of packages

Maintenance82

Actively maintained with recent releases

Popularity27

Limited adoption so far

Community13

Small or concentrated contributor base

Maturity52

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 98.1% 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 ~168 days

Total

4

Last Release

89d ago

Major Versions

v4.1 → v5.4.82026-03-06

### Community

Maintainers

![](https://www.gravatar.com/avatar/af7b0df8eb4b6ee517e24f00497b4bc37667cbc4af97cf71806598a6d8c1973d?d=identicon)[TAWK GmbH](/maintainers/TAWK%20GmbH)

---

Top Contributors

[![danielband](https://avatars.githubusercontent.com/u/72872468?v=4)](https://github.com/danielband "danielband (52 commits)")[![JonasLudwig1998](https://avatars.githubusercontent.com/u/146742086?v=4)](https://github.com/JonasLudwig1998 "JonasLudwig1998 (1 commits)")

---

Tags

pluginMauticintegration

### Embed Badge

![Health badge](/badges/tawk-gmbh-mautic-friendlycaptcha-bundle/health.svg)

```
[![Health](https://phpackages.com/badges/tawk-gmbh-mautic-friendlycaptcha-bundle/health.svg)](https://phpackages.com/packages/tawk-gmbh-mautic-friendlycaptcha-bundle)
```

###  Alternatives

[mautic/grapes-js-builder-bundle

GrapesJS Builder with MJML support for Mautic

5689.5k12](/packages/mautic-grapes-js-builder-bundle)[etailors/mautic-amazon-ses

Amazon SES Mailer Plugin for Mautic

563.4k](/packages/etailors-mautic-amazon-ses)[firemultimedia/mautic-multi-captcha-bundle

This plugin brings Google's reCAPTCHA, hCaptcha, and Cloudflare Turnstile integration to mautic.

141.1k](/packages/firemultimedia-mautic-multi-captcha-bundle)

PHPackages © 2026

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