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

Version 1 Next »

Short description

The app allows you to send reservations data in Apaleo to Maileon in real time. The reservation data is created as a contact event in Maileon, so you can set trigger letters for them.

Installation

For now, until the app is approved, you can install it from this url:

https://apaleo-integrations.maileon.com/apaleo-maileon/install

The installation steps are as follows:

Settings

After installation you will be taken to the settings interface

Maileon API key

The API Key can be created and viewed in the Maileon account under "Settings" → "API Keys" and ensures the connection to the account. When you save your settings, the API key will be checked and if it is invalid an error message will be displayed. Common errors:

  • Validity period exceeded

  • Key was deactivated in Maileon

  • Characters were truncated at the beginning or end

Initial permission

  • None: No permission. The contact will not receive newsletters, only transaction emails (e.g. reservation confirmation mail).

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

DOI process

If we enable the DOI process, then when the contact is created a confirmation email will be sent to the email address with a confirmation link, which if the contact clicks on will give them Double Opt-In Plus access to Maileon, regardless of what we have set in the above setting. If this option is not turned on, the contact will receive the permission set above instantly, without any confirmation.

DOI key

Here you can enter a DOI mailing ID, which determines which DOI mailing should be triggered as soon as a contact subscribes to the newsletter. The identifier can be set in Maileon or retrieved from the corresponding DOI mailing in the default settings. If the Maileon account has a default DOI mailing set in the settings, this field does not need to be filled in. Common mistake:

  • The DOI process above will be enabled but the DOI key is not specified here and no default DOI mailing is set in the Maileon account.

Apaleo properties

Here are the properties that exist in Apaleo. You can select the properties for which you want the reservation data to be transferred to Maileon.

Reservations send to Maileon

If this checkbox is ticked, the webhooks will be created for the above configured properties. The following webhooks are created:

  • reservation/created

  • reservation/amended

  • reservation/changed

  • reservation/canceled

Reservation contact events at Maileon

Webhook

Contact event

reservation/created

apaleo_reservation_created

reservation/amended

apaleo_reservation_amended

reservation/changed

apaleo_reservation_changed

reservation/canceled

apaleo_reservation_canceled

Contact events data fields:

Name

Type

reservation.id

string

reservation.bookingId

string

reservation.status

string

reservation.checkInTime

timestamp

reservation.checkOutTime

timestamp

reservation.cancellationTime

timestamp

reservation.noShowTime

timestamp

reservation.arrival

timestamp

reservation.departure

timestamp

reservation.created

timestamp

reservation.modified

timestamp

reservation.adults

integer

reservation.channelCode

string

reservation.promoCode

string

property.id

string

property.code

string

property.name

string

property.description

string

ratePlan.id

string

ratePlan.code

string

ratePlan.name

string

ratePlan.description

string

ratePlan.isSubjectToCityTax

boolean

unitGroup.id

string

unitGroup.code

string

unitGroup.name

string

unitGroup.description

string

unitGroup.type

string

totalGrossAmount.amount

float

totalGrossAmount.currency

string

primaryGuest.title

string

primaryGuest.firstName

string

primaryGuest.lastName

string

primaryGuest.email

string

primaryGuest.gender

string

primaryGuest.phone

string

primaryGuest.address.addressLine1

string

primaryGuest.address.addressLine2

string

primaryGuest.address.postalCode

string

primaryGuest.address.city

string

primaryGuest.address.regionCode

string

primaryGuest.address.countryCode

string

primaryGuest.preferredLanguage

string

primaryGuest.birthDate

string

additionalGuests

json

booker.title

string

booker.firstName

string

booker.lastName

string

booker.email

string

booker.gender

string

booker.phone

string

booker.address.addressLine1

string

booker.address.addressLine2

string

booker.address.postalCode

string

booker.address.city

string

booker.address.regionCode

string

booker.address.countryCode

string

booker.preferredLanguage

string

booker.birthDate

string

cancellationFee.id

string

cancellationFee.code

string

cancellationFee.name

string

cancellationFee.description

string

cancellationFee.dueDateTime

timestamp

cancellationFee.fee.amount

float

cancellationFee.fee.currency

string

noShowFee.id

string

noShowFee.code

string

noShowFee.name

string

noShowFee.description

string

noShowFee.fee.amount

float

noShowFee.fee.currency

string

Additional guests data fields

Name

Type

title

string

firstName

string

lastName

string

email

string

gender

string

phone

string

address.addressLine1

string

address.addressLine2

string

address.postalCode

string

address.city

string

address.regionCode

string

address.countryCode

string

preferredLanguage

string

birthDate

string

Contact fields at Maileon

Name

Type

Datatype

title

standard

string

firstname

standard

string

lastname

standard

string

fullname

standard

string

locale

standard

string

gender

standard

string

birthday

standard

string

address

standard

string

zip

standard

string

city

standard

string

country

standard

string

region

standard

string

Apaleo_last_reserveration_date

custom

date

Apaleo_was_guest_hotel_<property_code>

custom

boolean

  • No labels