Documentation Index

Fetch the complete documentation index at: https://support.lightspeedvt.com/llms.txt

Use this file to discover all available pages before exploring further.

Hookme Link

Prev Next

How to Use the 'hookme' Link to Extract User Attributes and Redirect with Parameters

The "hookme" link provides an efficient way to extract user-specific attributes and redirect users to a specified URL with these attributes appended as parameters. This guide explains how the "hookme" link works, its structure, and how to utilize it effectively using the example link below:

Example Hookme Link

https://vt.lightspeedvt.com/hookme.cfm?params=username,password,email,firstname,lastname,GlobalUserID,LocationID,LocationName&hook_url=https://google.com

Understanding the Structure of the Hookme Link

Base URL:
The core of the link is https://vt.lightspeedvt.com/hookme.cfm, which serves as the endpoint to initiate the process.

Params Parameter:
The "params" parameter specifies the user attributes to be fetched and included in the redirection.

Allow Attributes:

  • username: The user’s username.
  • password: The user’s password is encrypted using AES 128 (use with caution for security reasons).
  • email: The user’s email address.
  • firstname: The user’s first name.
  • lastname: The user’s last name.
  • GlobalUserID: A unique identifier for the user.
  • LocationName: The name of the location the user account belongs to.
  • LocationID: The user’s location identifier.

hook_url Parameter:
The hook_url specifies where the user is redirected after their attributes are retrieved.
In this example, the URL is https://google.com.

How It Works

Request and Attribute Extraction:
When the link is accessed, the system processes the params parameter and fetches the specified attributes for the user.

Appending Attributes to the Redirect URL:
The system appends the extracted attributes as query string parameters to the hook_url.

For instance, the user might be redirected to:

https://google.com?username=JohnDoe&password=12345&email=johndoe@example.com&firstname=John&lastname=Doe&GlobalUserID=67890&LocationID=123&LocationName=NewYork

Redirection:
The user is seamlessly redirected to the hook_url with the attributes included in the query string.

Practical Applications

Personalization:
Tailor the user experience by passing attributes to the destination page. For example, you can greet users by their first name or display their location-specific information.

Data Integration:
Easily integrate user data into external systems or third-party tools by including relevant attributes in the redirected URL.
Analytics and Campaigns:

Track user data for analytics purposes, such as campaign performance or user demographics, by including unique identifiers like GlobalUserID.

How to Customize the Link

Choose Relevant Attributes:
Adjust the params parameter to include only the attributes you need.

Relevant params example:

params=username,email,firstname,lastname

Specify the Redirect Destination:
Set the hook_url to the desired destination.

Destination URL example:

hook_url=https://yourwebsite.com/dashboard