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 2 Current »

General

This extension is responsible for handling subscriber and order information between Maileon and the FundraisingBox platform (https://fundraisingbox.com )

Installing

You can find this extension in Your Maileon account settings once enabled by the Maileon service team.

Screenshot 2024-07-16 at 10.12.00.png

Screenshot 2024-08-12 at 10.14.45.png

Configuration

The plugin setup process is handled in your Maileon account.

Screenshot 2024-08-12 at 10.16.03.png

Configuration actions

There are a few options after You filled out the form.

Save settings

When You click the Save settings button, we test your configuration to make sure it’s valid. After the successful test You can either close the window or press the initial sync button.

Initial sync

After successful configuration save, You can sync Your existing contacts from FundraisingBox to Maileon by pressing this button. This action may take a minute or two, so after its successful we’ll send an email notification about it to the Notification email.

Configuration fields

Field name

Description

Fundraisingbox Client ID

You can find your client id in your FundraisingBox account by clicking on your profile.

Screenshot 2024-08-12 at 09.59.12.png

Fundraisingbox Token

To receive your api token, you need to manually ask FundraisingBox support.

Maileon API Key

The API Key can be created and viewed in the Maileon account under "Settings" → "API Keys" and ensures the connection to your account. Make sure this API key is only used by this integration.

Screenshot 2024-08-12 at 10.07.40.png

Initial Sync Permission

Contacts created by initial sync functionality.

Initial Sync DOI process

You can choose if the mass synced contacts should start the DOI process.

Initial Sync DOI key

The key of the mailing that should be triggered with the DOI process for the mass synced contacts (if active)

Live Sync Permission

Permission for contacts created by the plugin on the fly.

Live Sync DOI process

You can decide if Maileon should start the DOI process for new contacts coming from FundraisingBox.

Live Sync DOI Key

The key of the mailing that should be triggered with the DOI process for new contacts (if active)

Notification email

An email address we can use to send notifications for about the plugin activity.

Webhooks

This plugin works based on webhooks both in Maileon and FudraisingBox.

Webhook setup in Maileon

In Maileon You should see two webhooks related to the plugin.

Action

Events

Webhook example setup

Contact unsubscribes through Maileon

unsubscription

Screenshot 2024-08-12 at 10.56.29.png

Contact accepts Double Opt In

doi

Currently the plugin creates the webhooks, but You need to manually add the JSON information to it. (as shown in the example setup, checkbox part).

Webhook setup in FundraisingBox

To send contacts and transactions to Maileon, the plugin needs webhooks on FundraisingBox side too.

Currently there is no way to create the webhook as a user or through api, which means You need to ask FundraisingBox support to create the webhooks.

Webhook configuration should look like this:

Event

Webhook type

Url

Donation

JSON webhook

https://fundraisingbox-xsic.maileon.com/fubox/api/donation?cid={{fundraisingbox_client_id&fid={{fundraisingbox_form_id}}&maid={{maileon_account_id}}

Available permissions

  • None: No permission. The contact will not receive newsletters.

  • Single Opt-in: Permission was simply granted, e.g. by entering an email address in a form. This method technically allows the contact to receive newsletters, but does not ensure that the email address belongs to the person who entered it.

  • Double Opt-in: With this permission, a confirmation email with a confirmation link is sent to the email address. Only when the link in the mail has been clicked and thus the interest in the entry has been confirmed, the contact can be sent.

  • Double Opt-in Plus: Double opt-in including consent for single user tracking. Please note: Without individual user tracking, no openings, clicks, etc. may be traced back to individual users and significant data for evaluating newsletter performance is missing. newsletter performance is missing.

Transaction data

Keys and data types of transaction object

fundraisingbox_donation_v1

 Fields for transaction fundraisingbox_donation_v1

Key

Data

donation.id

integer

fb_project_id

integer

amount

float

currency

string

receipt_status

string

public_name

string

public_message

string

Custom fields

Field

Data type

Description

FundraisingBoxPersonId

integer

The person id in FundraisingBox

FundraisingBoxAccountId

integer

The FundraisingBox account id

FundraisingBoxDonationCount

integer

The total donation count for a person

FundraisingBoxEmailId

integer

The id of the main email address for a person

phone

string

The phone number provided during the donation

Syncing all existing subscriber from FundraisingBox to Maileon

All subscribers can be transferred to Maileon. This is done in a background process. You will need to provide an email address to which a notification will be sent at the end of the import. The contacts will be created in Maileon with the permission selected in the Initial sync permission field. DOI process is handled based on Initial DOI process field (enabling it is not recommended for bulk imports). Once the import is complete, an email notification will be sent.

  • No labels