Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Current »

Overview

Pipedrive is a CRM specialized on managing contacts and deals. It allows surveilling contacts, deals, communication and provides insights to control the flows easier. The integration adds the possibility to subscribe contacts to Maileon using a DOI process and allows sending transactions, when a deal is created, updated or deleted.

Key Features

  • Automatic synchronization of newsletter subscribers to Maileon

  • Automatic synchronization of newsletter unsubscribers from Maileon to Pipedrive

  • Automatic synchronization of DOI confirmations

  • Transactional mailings for deals and change

Installation Guide

The first step is to install the app from the marketplace. Just go to https://www.pipedrive.com/en/marketplace, search for the Maileon app (Figure 1) and press the install button.

pipedrive-install-1.png

The app will ask for the following permissions (Figure 2):

  • Access to basic information
    This is a basic permission which is mandatory for all apps.

  • Deals: Read only
    This is required for submitting deals as transactions towards Maileon.

  • Contacts: Full access
    This is required to submit new subscribers to Maileon and sync back the unsubscribes from Maileon to Pipedrive.

  • Administer account
    This is the most critical permission, which is required as webhooks need to set up and as the permission management is not very fine grained, this permission is required.

  • Webhooks: Full access
    Real-time synchronisation requires webhooks. With this access, the app can create and delete webhooks.

pipedrive-install-2.png

Configuration

If the plugin activation process was successful, you will be redirected to the page of the plugin, where you can enter the settings (Figure 3 and Figure 4).

For accessing the configuration later, log into Pipedrive and go to this URL:

https://pipedrive-xsic.maileon.com/pipedrive-app

pipedrive-settings-1.png

1. 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 SettingsAPI 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.

2. Enable Pipedrive contacts sync

  • If you would like to sync your Pipedrive contacts with your Maileon account, then enable this option. If it's enabled, 3 webhooks will be created automatically. These webhooks will synchronize the contacts when you create, refresh and delete them. It won't work with the contacts you created earlier in your Pipedrive account.

3. Maileon contacts 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.

  • 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.

4. Enable Double Opt-in (DOI) 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.

5. Double Opt-in (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.

6. Enable Pipedrive deals sync

  • If this option is enabled, a contact event will be created in your Maileon account after you add or a new deal to a contact or update an existing deal in Pipedrive.

7. Enable custom fields mapping

  • Here you can set up 5 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 Pipedrive.
    These are for custom fields, see below what contact fields are synchronized by default in the integration.

pipedrive-settings-2.png

pipedrive-settings-3.png

Using the App

Contact sync

After saving the plugin, a person type custom field called “Newsletter” is created in the background in Pipedrive. This field will be used by the plugin to manage subscriptions. Never delete this custom field!

pipedrive-nl-custom-field.png


Here, the new contact can be subscribed to the Maileon newsletter (Figure 7). This option can of course also be viewed and edited in the details of the contact (Figure 8 and Figure 9).

pipedrive-contact-create.png

pipedrive-contact-details.png

pipedrive-contact-details-edit.png

The following contact data is submitted:

Field name

Field Maileon type

Description

Firstname

standard

First name

Lastname

standard

Last name

Fullname

standard

Full name

Organization

standard

Company name

External ID

standard

Pipedrive ID + Person ID

createdByPipedrive

custom

boolean

pipedriveId

custom

Pipedrive ID fro Maileon webhooks

owner_name

custom

The contact owner name

owner_email

custom

The contact owner email

Extra Custom fields

In the plugin settings you can set up 5 extra custom fields that should also be sent to Maileon as a contact custom field.

Deals sync

The first time a new deal is created or an existing deal is updated, a contact event type called “pipedrive_deal_added”, “pipedrive_deal_updated”, “pipedrive_deal_deleted“ is created in Maileon and will be filled with the data. The purpose of these contact events is to allow using the data in Maileon for filtering interesting contacts, not sending them mails about updated deals.

The three contact event types include the following fields:

Field name

Field type

Description

deal_id

integer

Deal ID

title

string

Deal title

value

integer

Deal value

currency

string

Deal currency

status

string

Deal status

person_name

string

Deal person name

org_name

string

Deal organization name

owner_name

string

Deal owner name

cc_email

string

Deal cc email address

expected_close_date

string

Deal excepted close date

timestamp

datetime

Deal created/updated/deleted timestamp

Uninstall the App

If you no longer need the App, please uninstall it. The following figures show how to uninstall the App.

pipedrive-installed-1.png

pipedrive-installed-2.png

pipedrive-uninstall.png

  • No labels