The Event component displays a time-based event. For example, you might use an Event component to display appointments or a list of event components to display a schedule, as shown below.
The Event component (
event) uses the following properties:
||String||Text displayed for the event||yes|
||String||Optional description of the event displayed next to the link.||no|
||String||A Unix timestamp in GMT associated with the event.||yes|
||String||URL to the content that displays in the takeover when the component is clicked. Must be served over HTTPS. Can include a JWT token.||no|
This graphic shows how the properties are used to display an Event component:
Here’s an example of the JSON to display the Event component shown in the above image.
Event Design Considerations
Keep the following in mind when using the event component:
- As Event components only display the event’s time, be sure to include the date elsewhere, such as in a Group component’s label.