Table of Contents

One Click Access

Amber Liggett Updated by Amber Liggett

One Click Access is used to create a link href that you can give your users to automatically register them for your program without the need to fill out the registration form. Using a variety of URL parameters, you are able to send key identity and demographic information about your members. If you would like to offer instant access to a program that is integrated directly on your website please refer to our Access Script article.

This article provides you with all the information you need to create and customize your One Click Access link. 

One Click Access Use Cases

One Click Access can:

One Click Access for Email Campaigns

To get started using the One Click Access feature, follow these steps to retrieve your link:

  1.  Navigate to Settings > Integrations or click here.
  2. Scroll down to External Service Integrations and select One Click Access for Campaigns
  3. Select the Program you'd like the link for.
  4. From the drop down menu, select the Email Service that you will be using to automatically create a link with the proper parameters. If your service is not listed, select Service Not Listed - Custom.
  5. Copy the link and customize the base URL with any additional parameters (optional). If you use the Custom option, you will need to refer to your email service to determine what their parameters are for first name, last name, and email. Then replace the tokens ({{FIRST_NAME}}, {{LAST_NAME}}, {{EMAIL}}) in your link with your email service's parameters.

To customize your Base URL link so that it will pull the necessary information to register your members, you will need to add parameters to the link. Here is a template of how to configure your One Click Access link:

One Click Access = [Your Base URL] + ?Parameter = value. 

All subsequent parameters are joined by an “&” symbol.

Parameter Encoding

If a contact has a special character (such as an apostrophe) in their name, this may break the link if it is not encoded. Each parameter needs to individually be encoded. This can be done in a variety of ways, depending on your coding environment.

This site shows what a encoded URL would look like in addition to a better understanding of URL encoding is and here's how to do it in JavaScript.

Identity and Demographic Parameters

You can customize your One Click Access link to pull key identity and demographic information about your members by adding any of the parameters below. 

Here are some examples:

  • Which program they should be in
  • An external ID for the member/user so you can match them in your system.
  • Name, email address, birthdate, phone, or other demographic information

Field

Values

Notes

Required?

programidentifier

String

Can be Program Name, Title, Program ID.

Yes

externalid

String

Used to reference user by ID (Usually your ID for the user).

No

fullname

String

Full names will be parsed into first and last , with a single space between.

No

firstname

String

Minimum 3 character

Yes

lastname

String

No

email

String (Valid email address)

Yes

customreferral

String

No

customtext1name

String

No

customtext1value

String

No

customoption1name

String

No

customoption1value

String

No

birthdate

String (Parsed to a date)

No

phone

String

No

Optional Control Parameters

You can also add parameters to control the logic of your link. 

Here are some examples:

  • Should the URL open a iframe friendly page, the widget, or a full page?
  • If the user doesn’t exist, should the system add them?  
  • Should I update demographic information on the member if they existed? This is a good way to keep all the data in sync between the systems.

Field

Default Value

Values

Notes

Required when Adding a Member?

sendregemailonadd

programrules

programrules, true, false

If value = program rules, it follows the rules of the program

No, uses default

view

site

site, widget, iframe

Redirects to either site, widget or iframe

No, uses default

addmember

true

true, false

Adds member if user does not exist by external id or email.

No, uses default

deniedpage

goes to codenotavailable

String URL

Redirects to page if access is denied

No

debug

true

true, false

Instead of redirecting, displays access link generated and all debug info, parameters, on page.

No, uses default

useemailon

true

true, false

If the first name is missing, we'll replace it with the email address.

No, uses default

directregistration

true

true, false

If we fail to login/add user we will direct the link to the registration page of that program. Note, the programidentifier must be set correctly.

No, uses default

Debugging

It’s important to debug your link to make sure it is working correctly and pulling all the correct data. The debug parameter is used to display access link generated data, debugging information, the result of the One Click Access link (did it fail, succeed, etc.) and a message detailing the results. 

You can also view every result in the Integration Event Logs, located on the Main Admin Page > Logs > Integration Events or by clicking here.  These will be under Type:  “One Click Access”

How did we do?

Integrating Your User Interface

iFrame

Contact