Telemarketing and street canvassing

Pre-filling campaigns in Onboarding

Senest redigeret:

The URL structure

The basic structure for linking to a campaign is as follows:
https://onboarding.onlinefundraising.dk/onboard?campaignGuid={ guid }&externalLeadId={ unique lead ID }

{ guid }, like all other { } in the examples, must be replaced with an accurate value. This value typically comes from another system, such as a telemarketing dialer.

With the value inserted, the link looks like this:
https://onboarding.onlinefundraising.dk/onboard?campaignGuid=edb909d0-50a3-4bf2-a5b0-208e2582fac7

Examples of all the standard fields included: 

 https://onboarding.onlinefundraising.dk/onboard?campaignGuid=edb909d0-50a3-4bf2-a5b0-208e2582fac7&pre_firstName=FLET&pre_lastName=FLET&pre_name=FLET&pre_msisdn=FLET&pre_email=FLET&pre_address=FLET&pre_address2=FLET&pre_postCode=FLET&pre_city=FLET&pre_countryCode=FLET&pre_nationalId=FLET&pre_birthDate=FLET&companyName=FLET&pre_businessCode=FLET&pre_externalId=FLET&product=FLET

Example incl. specific payment related info: 

 https://onboarding.onlinefundraising.dk/onboard?campaignGuid=edb909d0-50a3-4bf2-a5b0-208e2582fac7&pre_firstName=FLET&pre_lastName=FLET&pre_name=FLET&pre_msisdn=FLET&pre_email=FLET&pre_address=FLET&pre_address2=FLET&pre_postCode=FLET&pre_city=FLET&pre_countryCode=FLET&pre_nationalId=FLET&pre_birthDate=FLET&companyName=FLET&pre_businessCode=FLET&pre_externalId=FLET&product=FLET&pre_amount=FLET&pre_paymentMethodType=FLET&pre_scheduleType=FLET&pre_scheduleStartType=FLET&pre_scheduleStartWithOneOff=1

Required values 

campaignGuid: points to the campaign that is onboarded in. The campaign is defined by the OF client and has a specific workflow associated with it.

externalLeadId
Sometimes multiple payment attempts can occur for the same topic/lead. To provide a basis for better reporting, these sessions are grouped under the same lead. Therefore the externalLeadId must always be filled.

You decide what the ID is. For example, you can use your system ID or a member number from the customer. 

SupscriptionGuid (upgrade/winback only) 

SubscriptionGuid is required on campaigns if you are using an upgrade workflow. It allows you to change an existing subscription in different ways - e.g. by changing the amount or the payment method.

 https://onboarding.onlinefundraising.dk/onboard?campaignGuid={ guid }&externalLeadId={ unique lead ID }?subscriptionGuid={ guid }

Filling in contact data 

The following fields can be pre-filled on all campaigns if you choose to add them on the campaign workflow. The fields are used to pre-fill the contact.

  • pre_contactGuid(guid on an OnlineFundraising contact. If this is filled new agreements will be added on the existing contact in OnlineFundraising)
  • &pre_firstName
  • &pre_lastName
  • &pre_name
  • &pre_msisdn(phonenumber)
  • &pre_email
  • &pre_address
  • &pre_address2
  • &pre_postCode
  • &pre_city
  • &pre_countryCode
  • &pre_nationalId(CPR)
  • &pre_birthDate
  • &companyName
  • &pre_businessCode
  • &pre_externalId (be aware that this field may be in use. Double check with OF customer before using it for new purposes) 

Example: This is what a full URL for a specific campaign with pre-filled lead ID and first name will look like:

https://onboarding.onlinefundraising.dk/onboard?campaignGuid={ guid }&externalLeadId={ unique lead ID }&pre_firstName={ first name }

Filling in metadata

Onboarding allows the OF customer to get additional information - beyond what OnlineFundraising needs. This data is called metadata and is therefore uniquely created by the customer themselves. 

It is still possible to pre-fill them by knowing their name. It is available in the campaign workflow.

Onboarding.png

The above field is filled in as follows: &pre_source= { value }

An example with newsletter:

onboarding-newsletter.png

The addition on the link will look like this: &pre_newsletter=No
Pre_"Save as"
="one of your options" written in the same way (upper/lower case) as you have in the Value field.

Filling in products and payment info

The campaign workflow contains a number of products that can be selected. This is pre-filled by entering the number of the product in the workflow.

Example of typical setup

Onboarding__1_.png

  • &product = (number of product on the workflow) 

Products can be fully defined defined in advance in terms of frequency, start time and amount. Anything not predefined by the workflow can be pre-filled: 

  • &pre_amount={ amount }
  • &pre_purposeAccountingCode={ purposeAccountingCode }
  • &pre_paymentMethodType=[Test,Card,MobilePay,PaymentService] (predefined payment method)
  • &pre_scheduleType=[Monthly,Quaterly,Halfyearly,Yearly] (frequency)
  • &pre_scheduleStartType=[now, first, custom] (time of start of appointment)
  • &pre_scheduleStartWithOneOff=1 (if an immediate payment is requested, regardless of the start time of the payment agreement)

Note that for these values to be pre-filled, they must be selected as possible in the workflow.

If you want to preset the start time with an optional date, please use the following:

    • &pre_scheduleStartType=now
    • &pre_scheduleStartCustomDate={ yyyy-mm-dd }

Additional options for frequency selection (not usually used)

  • &pre_scheduleEveryOther=[1-24]
  • &pre_scheduleCalendarUnit=Month
  • &pre_scheduleFixedDay=[1-28]
  • &pre_scheduleBaseTier=[1-12]

Payment service: 

Payment service is a unique scenario in Onboarding, as there are several ways to handle it. Therefore, pay attention to how it is set up for each customer.

Should you wish to collect reg. and account numbers elsewhere (not recommended), they can be pre-filled on the following parameters.

    • &pre_sortCode={ sort code }
    • &pre_accountNumber={ account number }

An example:

This is how a full URL for a specific campaign with a pre-filled lead ID, product number 3 and an amount of 100 DKK would look like in the URL:  https://onboarding.onlinefundraising.dk/onboard?campaignGuid={ guid }&subscriptionGuid={ guid }&action=ChangePaymentMethod&pre_paymentMethodType=Betalingsservice&pre_sortCode=1234&pre_accountNumber=1234567890

The link does not work - what do I do? Some typical errors

Check the following if you find that Onboarding does not work with your URL.

1. Fill in or remove VALUE and [] values in the URL.
Parameters such as &pre_paymentMethodType=[Test,Card,MobilePay,Payment Service] contain all valid values such as Test, Card, etc. In your final URL, remove the entire parameter if you don't want to prefill it or define which value you want.

Correct usage:

 https://onboarding.onlinefundraising.dk/onboard?campaignGuid=edb909d0-50a3-4bf2-a5b0-208e2582fac7

or

https://onboarding.onlinefundraising.dk/onboard?campaignGuid=edb909d0-50a3-4bf2-a5b0-208e2582fac7&pre_paymentMethodType=Betalingsservice

2. Check for special characters
The final URL must not contain characters such as % [ ] ( ) . , or spaces.
If the URL contains any of these characters, you have probably either not cleaned the URL as suggested in point 1 or your system (e.g. dialer) is inserting data containing these characters. Check if you can get the data adjusted yourself or contact OnlineFundraising or the dialer.

3. Still not working
If you still can't get it to work please send an email to support@onlineFundraising.dk along with your URL. We'll help you find the problem.

Video review
In this video review we show what the agency needs to do to link to Onboarding:

Flet data ind i OnlineFundraising Onboarding som Agency:

In addition, we also have this review that shows what it looks like when payments are closed:

Sådan afsluttes betalinger i OnlineFundraising Onboarding