Teamleader Plugin
- 1 Overview
- 2 Installation
- 3 Configuration
- 3.1 Maileon Settings
- 3.1.1 Settings
- 3.1.1.1 Maileon API key
- 3.1.1.2 Enable Teamleader contact sync
- 3.1.1.3 Maileon contact permission
- 3.1.1.4 Enable Double Opt-in process
- 3.1.1.5 DOI Key
- 3.1.2 Custom Fields Settings
- 3.1.2.1 Enable custom fields mapping
- 3.1.1 Settings
- 3.2 Config page after install
- 3.3 Webhooks
- 3.1 Maileon Settings
- 4 Synchronized Data
- 5 Reauthorizing the Teamleader Scopes
Overview
The Teamleader Maileon Integration plugin provides a seamless, automated connection between Teamleader Focus and Maileon, enabling powerful email marketing workflows based on up-to-date CRM data.
Its primary purpose is to ensure that contacts, permissions, and subscription statuses remain perfectly synchronized between the two systems without requiring manual intervention.
Once connected through OAuth, the plugin continuously listens to Teamleader’s webhook events such as contact.added, contact.updated, and contact.deleted, and updates or unsubscribes contacts in Maileon accordingly. All relevant contact information—including personal details, addresses, marketing consent, and custom fields—can be mapped and transferred using a flexible configuration interface. The plugin also automatically creates and maintains the required Maileon custom fields and handles DOI processes when enabled.
In addition to inbound synchronization from Teamleader, the plugin also processes Maileon webhook events (DOI confirmations and unsubscriptions). These events are matched to Teamleader contacts via their external ID, ensuring that marketing permissions remain aligned in both systems at all times.
The integration includes built-in support for:
OAuth authentication & automatic token refreshing
Contact synchronization with mapping of Teamleader → Maileon standard and custom fields
Automatic creation and update of custom fields in Maileon
Webhook management for both Teamleader and Maileon
A modern configuration dashboard for managing API keys, permissions, DOI settings, and field mappings
Installation
To install the plugin visit the Teamleader Marketplace and search for Maileon.
After that you can install the Plugin by clicking on the Add button at the Plugin page.
If you are not logged in with your Teamleader account, you must log in.
Configuration
Maileon Settings
Settings
Maileon API key
The API Key is essential for establishing a connection to your Maileon account. You can create and view your API Key in your Maileon account by navigating to Settings → API Keys.
When you save your settings in the app, the API key will be validated. If the key is invalid, an error message will be displayed. Common errors include:
Validity period exceeded: The API key is no longer active.
Key was deactivated in Maileon: The API key has been disabled.
Characters were truncated at the beginning or end: Ensure the key is entered correctly without any missing characters.
Enable Teamleader contact sync
If you would like to sync your Teamleader contacts with your Maileon account, then enable this option. If it's enabled, 3 webhooks (add, update, delete) will be created automatically in Teamleader and 2 webhooks at Maileon (unsubscribe, doi confirm). These webhooks will synchronize the contacts when you create, refresh and delete them.
Maileon contact permission
None: No permission granted; the contact will receive only transaction emails (e.g., order confirmation).
Single Opt-in: Permission is granted by entering an email address in a form, but does not verify ownership of the email.
Confirmed Opt-in: With confirmed opt-in, a confirmation email is sent to the email address after the newsletter registration. However, this does not contain an additional confirmation link as with double opt-in; the newsletter registration becomes valid immediately.
Double Opt-in: A confirmation email is sent; the contact can only be sent emails after confirming via the link.
Double Opt-in Plus: Includes consent for single user tracking. Note that without individual tracking, data for evaluating newsletter performance may be limited.
Other: If permission cannot be proven, the ‘Other procedure’ method may be selected. However, this is expressly not recommended. Permission must always be verifiable.
Enable Double Opt-in process
Enabling the DOI process will send a confirmation email to the new contact's email address with a confirmation link. Clicking this link grants them Double Opt-In Plus access to Maileon, regardless of the settings above.
If this option is not enabled, the contact will receive permission immediately without any confirmation.
DOI Key
Enter a DOI mailing ID to determine which DOI mailing should be triggered when a contact subscribes to the newsletter. This identifier can be set in Maileon or retrieved from the corresponding DOI mailing in the default settings.
If a default DOI mailing is set in Maileon, this field does not need to be filled. A common mistake is enabling the DOI process without specifying the DOI key or setting a default mailing in Maileon.
Custom Fields Settings
Enable custom fields mapping
Here you can set up custom contact fields to send to Maileon when the contact subscribe. The same field name will be used in the Maileon. The drop-down list lists the custom fields in the Teamleader.
These are for custom fields, see below what contact fields are synchronized by default in the integration.
Config page after install
You can always visit the config page by going through the Login process on the login page.
Webhooks
If “Enable Teamleader contact sync” is enabled, webhooks will be created automatically when you click the save button, if they do not already exist. If Enable Teamleader contact sync is not checked, webhooks will be deleted automatically after saving. The following webhooks will be created:
Teamleader:
contact/added → create the Teamleader contact at Maileon
contact/updated → update the Teamleader contact at Maileon
contact/deleted → unsubscribe the Teamleader contact at Maileon
Maileon:
unsubscribe → set Opt-in marketing email to false at the Teamleader contact
doi confirm → set Opt-in marketing email to true at the Teamleader contact
Synchronized Data
The email address is not unique in Teamleader, so the contact will be created with external_id at Maileon. The external_id will be the Teamleader Contact id.
The contacts that will be transferred from Teamleader are those where the “Opt-in marketing emails” setting is accepted.
If you change this to not allowed for a contact, the contact will be unsubscribed in Maileon.
Synchronised Fields
Property | Field type | Sample |
|---|---|---|
External id | standard | 112223-12123443-2343434 |
standard | ||
First name | standard | Max |
Last name | standard | Mustermann |
Full name | standard | Max Mustermann |
Date of Birth | standard | 1980-01-12 |
Salutation | standard | Mr. |
Gender | standard | Male |
Locale | standard | en |
Address | standard | Test str. 3 |
City | standard | Test |
Country | standard | Germany |
Zip | standard | 1111 |
phone | custom |
|
mobile | custom |
|
website | custom |
|
iban | custom |
|
bic | custom |
|
national_identification_number | custom |
|
web_url | custom |
|
Other custom fields from Teamleader
The unique contact fields specified in the settings are created with the following type:
Teamleader field type | Maileon field type |
|---|---|
single_line | string |
multi_line | string (max 255) |
single_select | string |
multi_select | string (separated -> |) |
date | date |
money | float |
auto_increment | integer |
integer | integer |
number | float |
boolean | boolean |
string | |
telephone | string |
url | string |
company | string |
contact | string |
product | string |
user | string |
Reauthorizing the Teamleader Scopes
Because the authentication URLs of the Maileon integration have changed, all existing users must re-authorize the required Teamleader scopes. Without this step, the plugin will no longer be able to synchronize contacts or process webhook events.
Follow the steps below to re-enable the integration:
1. Open Teamleader Admin
Navigate to:
Admin → Settings → Integrations → Manage
2. Select the Maileon Integration
On the Integrations page, find Maileon and click:
Settings
3. Open the Integration Settings Page
Inside the Maileon integration, click:
Go to settings
4. Reauthorize the Scopes
You will be redirected to the Teamleader authorization screen.
Here, Teamleader will ask you to grant the required scopes again.
Click Allow to complete the process.
Once the scopes are accepted, the integration will continue working normally with the updated domain and redirect URLs.