Welcome to the WhenHub Developer Platform

Here, you'll find comprehensive guides and documentation to help you start working with WhenHub as quickly as possible, as well as support if you get stuck. Let's jump right in!

If you are new to WhenHub, please take a moment to learn more.

Build VisualizationsVisualizations

Create interesting interactive visualizations for Whencasts.

Get Started

Use the WhenHub APIWhenHub API

Programmatically interact with the WhenHub platform.

Get Started
WhenHub Developer Platform


WhenHub Schedule

The visualization receives all the information from the schedule in the form of a JSON object that is passed into a start method for the visualization by the Whencast Player. This includes the details of the schedule, such as title, curator, any custom fields created for the schedule, date created and other schedule related information. It also includes the events and all information that is associated with each event such as title, start time and date, end time and date (if it has an end date), description, links, and information for any media saved to the event. This information could be images, videos, files, or links to other websites. This can then be presented in the Player through HTML and JavaScript. You can even feel free to use the JavaScript framework of your choice.

Customizing Your Visualization with Settings

Customization can also be added to the visualization through the use of schedule settings. There are several settings that are built into the WhenHub Studio such as theme colors, etc. Visualizations can also define new settings that can be set on the schedule in the Studio. These settings can then be modified by the schedule curator to customize their Whencast. They are then passed to the visualization through the same start method as the schedules.

Interacting with the Whencast Player

Visualizations are also able to interact with the Whencast Player. Three handlers are provided to allow the interactions. The Ready handler notifies the Player when the visualization is ready to be loaded. This is often called after all of the rendering JavaScript is performed to improve performance of the visualization. The Details handler is used to view the full details of the event through the built-in Player's details view. The Navigation handler provides a method to slide navigation on the Player scrubber to the selected event in the visualization.

Updated 4 years ago

What's Next

General Settings


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.