Skip to content

Latest commit

 

History

History
76 lines (56 loc) · 3.49 KB

README.md

File metadata and controls

76 lines (56 loc) · 3.49 KB

Leuchtfeuer Identity-Sync

Allow sync of Mautic lead identity from external systems (e.g. CMS login) through a control-pixel with query-parameter.

Purpose

This plugin is useful when you have a user identity in a web application (e.g. shop customer / website frontend user / forum software user / …), and whenever a user completes a login on that system, you want to forward this identity to Mautic.

The basic idea is to do this through a URL call which carries the desired information as GET parameters.

With Mautic’s “traditional” mpixel.gif, you can update lead fields through URL (as long those fields are set to “Publicly updatable”). However, there are many situations where mpixel’s behavior does not seem to be perfect, and moreover there is no protection from forgery.

Therefore this plugin introduces a new mean called mcontrol.gif. To leverage this, your web application has to create a URL with the desired personal details. That URL should than be invoked e.g. as a pixel in your “login success” page, and you’re done.

Requirements / Version Support

  • Mautic 5 (starting from v2.0.0)
  • Mautic 4 (v1.0.0)

Installation

Composer

This plugin can be installed through composer.

Manual

Alternatively, it can be installed manually, following the usual steps:

  • Download the plugin
  • Unzip to the Mautic plugins directory
  • Rename folder to LeuchtfeuerIdentitySyncBundle
  • In the Mautic backend, go to the Plugins page as an administrator
  • Click on the Install/Upgrade Plugins button to install the Plugin. OR
  • If you have shell access, execute php bin\console cache:clear and php bin\console mautic:plugins:reload to install the plugins.

Configuration

The plugin has feature-settings to specify the contact-fields for identification:

Primary parameter (required): set the contact-field which is used as query-parameter for identification (e.g. email). Only fields are shown where field-setting "Is Unique Identifier" is true. Secondary parameter (optional): specify an additional query-parameter which is used in combination with the first one to enforce identification.

Usage

  1. Embed the control-pixel to the template of an external CMS where a customer is identified, e.g. after a successful login.
  2. Pass the identifier (e.g. the email-address) as query parameter to the control-pixel: https://my-mautic.site/[email protected].
  3. Optional: pass additional attributes or custom-fields of Mautic contacts to the control-pixel to update them (make sure that these attributes are set to "Publicly updatable"!): [email protected]&title=Sir&my_custom_field=Demo-Value.

Known Issues

List any current issues or limitations.

Troubleshooting

Make sure you have not only installed but also enabled the Plugin. If things are still funny, please try php bin/console cache:clear and php bin/console mautic:assets:generate

Change log

Future Ideas

Sponsoring & Commercial Support

We are continuously improving our plugins. If you are requiring priority support or custom features, please contact us at [email protected]

Get Involved

Feel free to open issues or submit pull requests on GitHub. Follow the contribution guidelines in CONTRIBUTING.md.”

Credits

@Moongazer @JonasLudwig1998

Author

Leuchtfeuer Digital Marketing GmbH Please raise any issues in GitHub. For all other things, please email [email protected]