Teamleader Plugin
The plugin allows us to synchronise our contacts in Teamleader with Maileon.
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.
Then redirects you to the plugin page .
Clicking the Login with TeamLeader
button takes you to TeamLeader authorization page.
After the authorization process you should be redirected to your Plugin Settings screen:
The final step is to enter the API key of the Maileon account you wish to integrate with. For more information about Maileon API keys please contact your Maileon distributor.
Click the TestAPI Key
to test the key you’ve supplied. Now you can proceed to configuring your integration.
Note: At the section ‘Webhooks’ you should see your unique webhooks settings which you can copy into your maileon settings. (See at Configuration/Webhooks)
Don’t forget to Save
the configuration after you’ve statisfied with your settings.
You can always visit this page by going through the Login process on the login page.
Configuration
Maileon Settings
Contact Settings
Maileon API Key
This is the API key you’ve supplied during installation. You can always change this key by clicking the Change API Key
button and submitting a new value.
Double Opt-in Process
With this option enabled a double opt-in process will be started for each contact that is created in your TeamLeader account.
Double Opt-in Process Plus
With this option enabled the double opt-in process will result in a double opt-in plus permission instead of double opt-in. Only available if the DOI process is enabled.
Double Opt-in Mailing Key
If you want to customize the DOI mailing that will be sent from Maileon you can input the key of the mailing here. Only available if the DOI process is enabled. Do NOT leave this field empty if your Maileon account has no default DOI mailing set!
Contact Permission
If you want to just create Maileon contacts with a set permission you can select it here. Only available if the DOI process is disabled.
Teamleader Contact Custom fields
Here you can select the Contact Custom fields you have created in Teamleader that you want to be transferred to Maileon. They will be created with the same name as they have in Teamleader.
Webhooks
Unsubscription
The webhook URL to use in Maileon for unsubscription events.
Maileon Webhooks Configuration
If you want Maileon to publish relevant changes to your TeamLeader contacts you should configure Maileon webhooks. You can find the Webhook URLs in the Maileon Settings section.
Unsubscription Webhook
Unsubscription events should have the following JSON information enabled:
external id (required)
Example configuration in Maileon:
For more information about Maileon webhooks please contact your Maileon distributor.
Synchronized Data
The plugin creates 3 webhooks in Teamleader after installation:
add → Create the Teamleader Contact at Maileon
update → Update the Teamleader Contact at Maileon
delete → Unsubscribe the Teamleader Contact at Maileon
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 |