A widget in ActivityHero is a link or code snippet that allows families to register for your offerings outside of the ActivityHero marketplace — for example, on your website or in a marketing email.
After you enter your schedules on ActivityHero, they will instantly appear on your website when you add the widget code to your web page. Widgets show session availability, discounts, additional fees, and enable users to register online without leaving your website.
Create a New Widget
- Sign into your ActivityHero account and go to Dashboard Home
- Go to "Tools for Your Website" > "Online Registration Widget"
- Click the blue "Create Widget" button on the right side of the screen.
- Select the Locations you'd like to appear in your widget. Note: if you choose a location that is marked Unpublished or not-used, sessions marked with this location will not appear in the widget.
- Choose a Widget type, and name your Widget. The Widget URL field will update automatically as you make changes.
- Click the "Create widget" button to generate your widget:
Customize Your Widget
You can customize how the registration appears on your site. Just add a few items from the list below. Add the parameters to the Widget iframe URL, separated by ‘&’.
- For example to show On-Demand activities only:
Ex. src="https://www.activityhero.com/providers/schedule_widget?id=16225&on_demand=true"
Customize the Display Order of Activities on Widgets
By default, activities are ordered by start date, then alphabetically by activity name. However, you can customize the order in which activities appear on your widgets/website using the "ordered_activities=" parameter. Be sure to include all activity ID's separated by commas.
|
Parameter Name |
Possible Values |
Default |
Description |
|
grade |
any integer from -1 to 99 |
Display all grades |
If a value is specified, filters the results to display schedules only for the specified grade |
|
age |
any integer value in months, or a range in months |
Display all ages |
If a value is specified, filters the results to display schedules only for the specified age in months. For example, to specify classes for 3 year olds, use "36". You can also specify a range (ex: "12-36"). |
|
classes |
TRUE |
Display classes |
Display classes |
|
camps |
TRUE |
Display camps |
Display camps |
|
events |
TRUE |
Display events |
Display events |
|
online |
TRUE |
Display online sessions |
Display online sessions |
|
on_demand |
TRUE |
Display On-Demand contents |
Display On-Demand contents |
|
category |
category name |
Display all categories |
Display only activities with the specified category |
|
start_date |
yyyy-mm-dd |
Display all schedules |
Display only schedules that end after this date |
|
end_date |
yyyy-mm-dd |
Display all schedules |
Display only schedules that start before this date |
|
activities |
comma separated activity ids |
Display all activities |
Display schedules of only specified activities |
|
exclude_activities |
comma separated activity ids |
Display all activities |
Exclude schedules of specified activities |
|
exclude_sessions |
comma separated activity schedule ids |
Display all sessions |
Exclude sessions of specified schedule ids |
|
disable_enroll_button |
true, false |
Display CTA on all schedules |
Hide enroll button from all schedule rows |
|
schedule_display_view |
calendar |
Provider's default display view |
It will set default display view for schedules |
|
locations |
comma separated location ids |
current location id |
It will fetch schedules for all the specified locations |
|
activity_schedules |
comma separated activity-schedule ids |
all published schedules |
It will fetch all the specified schedule(s) |
|
show_grade_filter (works only in new schedule widget) |
true/ false |
FALSE |
It will show grade filter |
|
show_days_filter (works only in new schedule list widget) |
true/ false |
FALSE |
It will show days filter |
|
photos |
true/ false |
FALSE |
It will show photos in calendar view |
|
private_only |
true, false |
FALSE |
It will show only private activities |
|
ordered_activities (works only in new schedule widget) |
Comma separated activity ids |
Display all activities |
It will sort the activities by activity ids |
To edit a Widget:
- Sign into your ActivityHero account and click Dashboard Home
- Go to "Tools for your Website" > "Online Registration Widget"
- Click "edit" next to the Widget you would like to update
- Add parameters to the Widget iframe URL section using the format listed above.
- Click "Update Widget".
Widget Types
The List View uses photos and has a clean, modern layout for both desktop and mobile view. The first 250 characters of your activity description will appear in the widget.
The Calendar View displays a 1-week calendar view of your activities. This view is best if you hold many classes on multiple days, or have many single-day classes. With the Calendar View you have the option to include photos or leave them out.
Calendar View with no photo
Calendar View with Photo
Widget Uses
There are three types of widgets available for use on your website. The one you use will vary based on how you would like to take registration.
- Embed full widget directly on your page: This code states "Place this code wherever you want the widget to appear on your page". When you use this code, your widget will appear at full size and will include all sessions. Your web page will adjust to the size of the available sessions.
- Embed full widget in an iframe on your page: This code states "If you just want to embed the widget in an iframe, use this code". Use this code if you are placing your widget inside a web page and do not want to adjust the overall size of the page. Instead your widget will appear within another box on the page, which will allow scrolling to see all available sessions.
- Link to the widget via a button or other element on your web page: This code states "If you just want to link to the widget, use this code instead". The page that becomes available will now include your business branding. Parents will be able to log in or sign up to complete their registration.
- Your sessions are displayed in the widget based on the earliest session start and end dates. If the dates are the same, then the following criteria is used to sort the sessions:
- Start and end time (earliest first)
- Activity name
- Session name
- Grades (lowest first)
- Ages (lowest first)
- Price (lowest first)
If you would like more information on accepting registrations using ActivityHero call 800-437-6125 or email team@activityhero.com