Overview
Custom widgets let third-party developers customize Cvent event registration by building and integrating custom components. Knowledge of JavaScript and HTML Web Components is required.
Find an example custom widget here.
Widget Element
Custom widgets serve as HTML custom elements that let you build new UI or features on your event website. These widgets face registrants and also display to planners when they build a site. Learn more about the widget element.
Editor Element
Each custom widget has an editor element. This element allows the event planner to edit the configuration fields passed to the widget. This element only appears in the site designer when editing a custom widget. Learn more about the editor element.
Widget Configuration
Each custom widget has a configuration file element. The configuration file defines the product and purpose of the custom widget, along with other essential properties.
Learn more about Custom Widget configuration.
Publishing
You must publish the configuration file config.json
,
the editor file editor.js
, and the widget file widget.js
at the time of widget creation.
Learn more about Custom Widget publishing.
Widget SDK
Both widget and editor elements can access the custom widgets software development kit (SDK) to retrieve information about the event. Learn more about the custom widget SDK.
Limitations
- Custom Widgets don’t version with the site designer. This means that any changes you make to a custom widget reflect in the site designer and guest site for any event where you placed it, even if you haven’t republished the site with the updated assets.
- Custom Widgets with registration actions can’t override business rules that Cvent has put in place. For instance, the widget can’t allow an invitee to register for a session not available to their registration type.
- You can’t use Custom Widgets to add sessions for an invitee’s guest agenda or on the guest information page.
- Custom Widgets require a hard refresh or navigation to the next page to update when changes to the end user’s language occur.
Support
Cvent Support can’t help you debug code written by developers or provide guidance on how to use the methods available in the Custom Widgets SDK.