Skip to main content

Return to TX Community

Liaison

Limiting which events display to registrants using URL parameters

Events

TargetX Events supports adding parameters to your Events Site URL to restrict which events are displayed. This can be used to pre-filter events based on data points such as location, category, type, and more. Below are instructions for adding parameters based on which data points will be used as filters.

Data Point

Description

Parameter to Add

Example

Contact Specific Events (My Events) Adding the Contact ID value to the end of your Events Site URL allows registrants to self-manage their registrations by viewing upcoming events or changing their registration. When the Contact ID is included in the URL, registrants may bypass the registration form because their information is already in the system.  #/myevents?cid={!Contact.Id} &k={!Contact.TargetX_Base__Access_Key__c} https://targetx.secure.force.com​/events#/myevents?cid=0012300000Ab1cD&k={!Contact.TargetX_Base__Access_Key__c}
Featured Events Adding a filter for featured events will display only those marked as "Featured" on the Organization Event record.  #/featured https://targetx.secure.force.com​/events#/featured
Category Filtering on the Category value will display Events that belong to a certain Category, as defined on the Organization Event record. #/calendar?category=<<Category picklist value>> https://targetx.secure.force.com​/events#/calendar?category=Undergraduate+Admissions
Type Using a filter for type will allow you to restrict only those events with the given type value on the Organization Event record.  #/calendar?type=<<Type picklist value>> https://yourschool.secure.force.com​/events#/calendar?type=Open+House
Multiple Types To filter multiple types add a comma followed by the second item: #/calendar?type=<<Type picklist value>>, <<Type picklist value>> https://yourschool.secure.force.com​/events#/calendar?type=Open+House, Reception
Keyword If you are using Keywords within events, you can add filters to restrict the search results to those that match the keyword in your URL.  #/calendar?keyword=<<Keyword picklist value>> https://yourschool.secure.force.com​/events#/calendar?keyword=Business+School
Location If you have created Location records and associated them with events, you can add the Location Filter Value to your URL and display only those events at that location: #/calendar?location=<<Location Filter Value>> https://yourschool.secure.force.com​/events#/calendar?location=Las Vegas

 

Using Multiple Filters

You can add multiple restrictions, such as Category and Type, by combining the values with an & symbol. 

  • EXAMPLEhttps://yourschool.secure.force.com​/events#/calendar?category=Undergraduate&type=Open+House

When adding your URL parameters, do not include spaces. Instead, use + or ?20 where spaces may be located in your values. 

Restricting Appointment Options Using URL Parameters

A custom URL can be sent to students to restrict them to specific options when they schedule an appointment. For example, an email alert can be configured to send an email to a student referred to the Writing Center. As part of the email, you can restrict the appointment URL to a specific Location or Person.

Standard appointment scheduler URL: 

  • https://<<your institutions’s CRM Community>>/targetx_eventsb__myappointments

The following URL parameters can be added/included to restrict the available options further when a student goes to schedule an appointment. One or all of these URL parameters can be specified. Note: Old URLs will continue to work with the New UI; they will redirect and retain your URL parameters.:

Data Point

Description

Parameter to Add

Example

Custom Field You can reference any Custom fields in URL parameters if you have configured a Custom Filter field in Appointment Scheduler Settings ?custom=<<Custom Filter Value>>

https://yourschool.secure.force.com​/appointments/targetx_eventsb__AppointmentScheduler?custom=MyValue

NEW UI: https://yourschool.secure.force.com​/appointments/ targetx_eventsb__myappointments?custom=MyValue

Reason

  • Specific reason values such as Math Center, Tutoring, etc.
  • Multiple Reasons can be specified by comma separating the reason values
  • If the Reason contains spaces, replace the space with a plus (+) sign. *This is standard URL parameter functionality.
?reason=<<Reason Value>>

https://yourschool.force.com/targetx_eventsb__AppointmentScheduler?reason=Math+Center

NEW UI: https://yourschool.force.com/targetx_eventsb__ myappointments?reason=Math+Center

Location

  • Specific location value, such as Main, Downtown
  • Multiple locations can be specified by comma separating the reason values
  • if the Location contains spaces; replace the space with a plus (+) sign. *This is standard URL parameter functionality.
?location=<<Location Value>>

https://yourschool.force.com/targetx_eventsb__AppointmentScheduler?location=Downtown+Campus

NEW UI: https://yourschool.force.com/targetx_eventsb__ myappointments?location=Downtown+Campus

Person
  • User ID for a specific advisor/staff/faculty
  • Multiple people can be specified by comma separating the User ID values
?person=<<User Id>>

https://yourschool.force.com/targetx_eventsb__AppointmentScheduler?person=005i0000001OPk7

NEW UI: https://yourschool.force.com/targetx_eventsb__ myappointments?person=005i0000001OPk7

Modalities You can use URL parameters to filter Meeting Modality Types to restrict the options for a student scheduling an appointment.

#/calendar?type=<<Modality>>

Modality options:

  • In-Person
  • Virtual
  • Phone

https://yourschool.force.com​/events#/calendar?type=Virtual

NEW UI: https://yourschool.force.com/targetx_eventsb__ myappointments?type=Virtual

Multiple Parameter Example: 

  • Reason and Location:

https://targetxuniversity.force.com/targetx_eventsb__AppointmentScheduler?person=005i0000001OPk7,005f0000001pveh&reason=Math+Center&location=Main+Campus

NEW UI Multiple Parameter Example:

  • Reason and Location:

https://targetxuniversity.force.com/targetx_eventsb__myappointments?person=005i0000001OPk7,005f0000001pveh&reason=Math+Center&location=Main+Campus

 

  • Was this article helpful?