This article is your guide to pre-filling information via URLs about contacts, metadata, and products in your Onboarding campaigns. For example, you may pre-fill all contact data for a donor, so the phoner/lead only needs to verify that it is still correct. Alternatively, you may want to merge information about the existing agreement, which campaign the donor has most recently signed up for, or metadata about the segment. The possibilities are many – and pre-filling fields is a great advantage for the phoner.
Prefer to watch rather than read? Find the video here >
URL-strukturen
For at forudfylde en formular skal du tilpasse den url, der leder hen til siden med din formular. Hvert felt, der skal være forudfyldt, skal tilføjes med en særlig syntax:
pre_feltnavn=værdi
Du laver dine tilføjelser i slutningen af det link, som leder hen til siden med din formular. Hvis du f.eks. vil forudfylde formularen med 1000 kroner, ser det ud på følgende måde:
https://www.JeresUrl.dk/tilFormularen?pre_amount=1000
Ønsker du at tilføje mere end et parameter, kan du blot tilføje et "&"-tegn efter det første parameter. I følgende eksempel tilføjer vi en årlig frekvens til de 1000 kroner.
https://www.JeresUrl.dk/tilFormularen?pre_amount=1000&pre_recurringFrequency=yearly
The basic structure for linking to an Onboarding campaign is as follows:
https://onboarding.onlinefundraising.dk/onboard?campaignGuid={guid}&externalLeadId={unique lead ID}
Replace the values in {} with actual values. These values are typically provided in OnlineFundraising, but they can also come from an external system, such as a telemarketing dialer.
Example - sign-up campaign (Sign-up)
This example contains the fields that must at a minimum be filled out for a Sign-up campaign, namely the campaign's ID and the lead's ID:
https://onboarding.onlinefundraising.dk/onboard?campaignGuid=edb909d0-50a3-4bf2-a5b0-208e2582fac7&externalLeadId=mitLeadId
The example below contains all the fields that can be merged into a Sign-up campaign by default:
https://onboarding.onlinefundraising.dk/onboard?campaignGuid=edb909d0-50a3-4bf2-a5b0-208e2582fac7&externalLeadId=mitLeadId&pre_firstName={firstName}&pre_lastName={lastName}&pre_name={name}&pre_msisdn={msisdn}&pre_email={email}&pre_address={address}&pre_address2={address2}&pre_postCode={postCode}&pre_city={city}&pre_countryCode={countryCode}&pre_nationalId={nationalId}&pre_birthDate={birthDate}&companyName={companyName}&pre_businessCode={businessCode}&pre_externalId={externalId}&product={product}&pre_amount={amount}&pre_paymentMethodType={paymentMethodType}&pre_scheduleType={scheduleType}&pre_scheduleStartType={scheduleStartType}&pre_scheduleStartWithOneOff={scheduleStartWithOneOff}
It is possible to add custom fields. Read more about this in the section on Filling in metadata.
Example – upgrading/changing an existing agreement (Upgrade)
This example contains the fields that must at a minimum be filled out for an Upgrade campaign:
https://onboarding.onlinefundraising.dk/onboard?campaignGuid=edb909d0-50a3-4bf2-a5b0-208e2582fac7&externalLeadId=mitLeadId&subscriptionGuid=950dg7sb-50a3-4bf2-a5b0-208e2598hd6a
Required values
- campaignGuid: An ID that points to the campaign being onboarded to. The campaign is defined by the OF customer and is associated with a specific workflow.
- ExternalLeadId: Sometimes multiple payment attempts can occur for the same subject/lead. To provide better reporting, these sessions are grouped under the same lead. Therefore, ExternalLeadId must always be filled out. You decide what the ID is. For example, you can use your system's ID or a membership number from the customer.
- SubscriptionGuid (Only upgrade/winback): Required for campaigns using an upgrade workflow. This allows changes to an existing agreement in various ways – for example, by changing the amount or payment method.
Filling in contact data
The following fields can be pre-filled for all campaigns if you choose to add them to the campaign's workflow. The fields are used to pre-fill the contact information.
- pre_contactGuid (GUID of an OnlineFundraising contact. If this is filled out, new agreements will be added to the existing contact in OnlineFundraising)
- pre_firstName
- pre_lastName
- pre_name
- pre_msisdn (phone number)
- pre_email
- pre_address
- pre_address2
- pre_postCode
- pre_city
- pre_countryCode
- pre_nationalId (CPR number)
- pre_birthDate
- companyName
- pre_businessCode
- pre_externalId
Filling in metadata
Onboarding allows you (the organisation) to collect additional information – beyond what is available by default in OnlineFundraising. This data is called metadata and is therefore uniquely created by the customer themselves.
It is still possible to pre-fill them, using the field name. It can be found in the campaign's workflow:
For example, source here:
The above field is filled out as follows:
&pre_source={værdi}An example with a newsletter:
The addition to the link will look like this for a default value of 'No':
&pre_nyhedsbrev=Nej
Filling in products and payment information
The campaign's workflow contains a number of products that can be selected. This is pre-filled by specifying the number assigned to the product in the workflow.
Example of a typical setup
Below is an example of a product in a Signup campaign, which has the number '1':
Syntax for pre-filling a product:
&product={number of workflow product}Products can be fully defined in advance in terms of frequency, start time, and amount. Read more about creating a product for a recurring agreement here, and a single donation here.
Everything that is not predefined by the workflow can be pre-filled:
- pre_amount={ amount } (amount)
- pre_purposeAccountingCode={ purposeAccountingCode }
- pre_paymentMethodType=[Test,Card,MobilePay,Betalingsservice] (pre-selected payment method)
- pre_scheduleType=[Monthly,Quarterly,Halfyearly,Yearly] (frequency)
- pre_scheduleStartType=[now, first, custom] (start time for the agreement)
- pre_scheduleStartWithOneOff=1 (if an immediate payment is desired, regardless of the start time for the payment agreement)
Note that for these values to be pre-filled, they must be selected as options in the workflow.
If you wish to pre-select the start time with an optional date, use the following:
- pre_scheduleStartType=now
- pre_scheduleStartCustomDate={ yyyy-mm-dd }
Additional options for selecting frequency (usually not used):
- pre_scheduleEveryOther=[1-24]
- pre_scheduleCalendarUnit=Month
- pre_scheduleFixedDay=[1-28]
- pre_scheduleBaseTier=[1-12]
Betalingsservice: Betalingsservice is a unique scenario in Onboarding, as there are several ways to handle it. Therefore, be aware of how it is set up for each customer.
If you wish to collect bank registration and account numbers elsewhere (not recommended), they can be pre-filled with the following parameters:
- pre_sortCode={ sort code }
- pre_accountNumber={ account number }
An example
This is how a full URL for a specific campaign with pre-filled lead ID, product number 3, and an amount of 100 DKK would look:
https://onboarding.onlinefundraising.dk/onboard?campaignGuid=edb909d0-50a3-4bf2-a5b0-208e2582fac7&externalLeadId=mitLeadId&product=3&pre_amount=100
Filling in actions in an Upgrade campaign
All actions in an Upgrade campaign can be pre-filled via their parameters:
- action=[AgreementUpdate,CreateAddOn,ChangePaymentMethod,SubscriptionActions]
An example:
This is how a full URL for a specific campaign with a pre-filled subscription, set to change the payment method to Betalingsservice, where the registration number is set to 1234 and the account number is set to 1234567890, would look in the URL:
https://onboarding.onlinefundraising.dk/onboard?campaignGuid=edb909d0-50a3-4bf2-a5b0-208e2582fac7&externalLeadId=mitLeadId&action=ChangePaymentMethod&pre_paymentMethodType=Betalingsservice&pre_sortCode=1234&pre_accountNumber=1234567890
Things you need to be aware of:
Check the following if you experience that Onboarding is not working with your URL:
1. Fill in or remove the VALUE and [] values in the URL.
Parameters such as &pre_paymentMethodType=[Test, Card, MobilePay, Betalingsservice] contain all valid values such as Test, Card, etc. In your final URL, you should remove the entire parameter if you do not want to pre-fill it or define which value you wish to use.
Example of correct usage:
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 likely either not cleaned the URL as suggested in point 1, or your system (e.g., dialer) is inserting data that contains these characters. Check if you can adjust the data yourself or contact OnlineFundraising or the dialer.
3. Does it still not work?
If you still cannot get it to work, send an email to support@onlinefundraising.dk along with your URL. We will help you find the problem.
Video walkthrough
See what the agency needs to do to link to Onboarding.
See what it looks like when the payments are completed.