The basics relating to a HeySummit integration that you need to know before beginning a HeyConnect configuration.
Introduction
When a customer decides to use HeySummit to manage their events, but requests to use an unintegrated webinar/networking product to manage the delivery of their content, then a simple HeyConnect powered integration is the answer. Please refer to the information below to understand exactly what a HeyConnect powered integration consists of.
HeySummit Integration User Flow
The user flow is illustrated below and can be simply stated that everything related to organising the Event is in the domain of HeySummit while the experience of the live webinar content is within the webinar/networking system.
Terminology
In order to understand the purpose of an integration it is important to understand the meaning of the terms used in each system and how they correspond across the two systems.
HeySummit Term: ‘Partner’
- Meaning: A 'Webinar Provider' that has decided to partner with HeySummit and create an integration
HeySummit Term: ‘Webinar Provider’
- Meaning: The partner system user by the Event Organizers and Speakers to host the online meeting, (e.g. Zoom).
- Common Webinar Equivalent: n/a
HeySummit Term: ‘Event Organizer’
- Meaning: The person organising the online event who owns the HeySummit account and is also a HeySummit user.
- Common Webinar Equivalent: n/a
HeySummit Term: ‘Event’
- Meaning: The summit, conference, trade show or collection of meetings organized by the Event Organizer. An ‘Event’ will have one or more speakers (presenters) delivering one or more talks (webinars)
- Common Webinar Equivalent: Some webinar systems have a direct cross over but many do not have this concept or related functionality which is why an integration with HeySummit is the answer.
HeySummit Term: ‘Host’
- Meaning: Often the same individual as the ‘Event Organizer’. The ‘Host’ is the individual in charge of facilitating the ‘Talk’. The person who organizes speakers, starts the webinar and chairs the talk. The ‘Host’ is a technical object within HeySummit but is not passed as part of the integration. The HeySummit user flow expects the webinar platform to be enabled prior to connection.
- The ‘Host’ is considered to be the user that provides authorization for the connection either by OAuth1 or OAuth2 standard. We assume that they exist as a user of the webinar account already and therefore we do not have to create them.
- Common Webinar Equivalent: This individual may be the ‘Webinar Account Holder'. Some webinar systems have ‘Users’ or ‘Team Members’ that can be assigned different roles that correspond e.g. ‘Administrators’, ‘Organizers’ or ‘Moderators’. A ‘Host’ is usually ascribed the maximum user rights within the webinar platform so that the can manage the room, content and attendees.
HeySummit Term: ‘Speaker’
- Meaning: The individual delivering the ‘talk’, ‘lecture’, ‘presentation’ or equivalent from any industry. A talk will have one or more ‘Speaker(s)’.
- The ‘Speaker’ is a technical object within HeySummit and HeyConnect.
- Common Webinar Equivalent: Most webinar systems appear to have an equivalent. The ‘Speaker’ is mapped to the closest equivalent e.g. ‘Presenter’ or ‘Panellist’. A ‘Speaker’ must be ascribed the user rights within the webinar platform required to deliver the content and engage with the attendees but not to manage the entire platform.
HeySummit Term: ‘Talk’
- Meaning: A lecture, seminar, meeting or other industry equivalent. An ‘Event’ will always comprised of one or more ‘talks’.
- The ‘Talk’ is a technical object within HeySummit and HeyConnect.
- Common Webinar Equivalent: The ‘Talk’ is the core of the connection between HeySummit and the webinar provider. All webinar providers have a concept of a ‘webinar (room/session)’ where the live webinar is delivered and attended. Different systems have different types of 'webinar room’ and different terms that refer to them. With the present HeyConnect functionality it is best to map the talk to the most generic ‘webinar room/session’ available in the system.
HeySummit Term: ‘Attendee’
- Meaning: An individual that subscribes to a ‘talk’, ‘lecture’, ‘presentation’ or equivalent from any industry.
- The ‘Attendee’ is a technical object within HeySummit.
- Common Webinar Equivalent: All webinar systems have an equivalent concept e.g. ‘Registrant’ or ‘Participant’ however some systems ‘register the ‘Attendee’ in advance while others do not.
- Where an attendee is registered in advance the ‘Attendee’ is mapped to the system equivalent e.g. ‘Create Webinar Registrant’.
- Where the attendees are not registered in advance then your system will inevitably have an equivalent that provides participants with a unique access code that identifies them on joining the meeting. In these instances this would be the correct mapping.
HeyConnect Integration Standard
The assumption of the HeyConnect integration between HeySummit and a webinar/networking platform is that the ‘Event’ will be managed in HeySummit and the event content will be experienced via your platform. Therefore the majority of the communication is initiated from HeySummit to the webinar/networking platform. A complete 2 way API communication is not expected at this stage.
A successful configuration of HeyConnect must display a fully functional interaction initiated from HeySummit ‘calling’ and the partner webinar system supplying the required details in a configured ‘response’. The required interaction comprises of a HeySummit user:
Note: Even if a system does not support actual participant pre-registration the add attendee event must be configured so that the unique join url for a participant can be generated and provided to HeySummit. For example if a system require a POST request including participant details to get_access_token then this would be the correct mapping.
Questions
We are happy to clarify any details or answer any questions you may have.
Email: integrations@heysummit.com
