Integration with Cvent
- 1 Updates
- 2 General Information
- 3 Data Synchronization
- 4 Example of Use Cases
- 5 Connecting the Events Between Cvent and Touchcast
- 5.1 Using Webhook
- 5.1.1 On Touchcast:
- 5.1.2 On Cvent:
- 5.2 Using REST APIs (Participation Tracking)
- 5.2.1 On Cvent:
- 5.2.2 On Touchcast:
- 5.1 Using Webhook
- 6 Mapping the Fields
- 6.1 Default fields
- 6.2 Additional fields
- 6.3 Custom fields
- 7 Managing Custom Access
- 8 Integration in Action
- 9 Out of Scope/Next Versions
Updates
December, 01, 2021 - Added the Default field “Profile image”. This field is passed from Cvent to Touchcast by default.
March, 10, 2022 - REST APIs and Participation tracking.
General Information
The Cvent - Touchcast integration allows to:
pass registrants data from Cvent into Touchcast when the registration for an event is done via Cvent.
Pass participation data from Touchcast back to Cvent based on the established criteria.
This integration implies usage of webhooks on the Cvent side. Not all Cvent accounts have webhooks enabled. To enable webhooks (Push APIs) on Cvent, the account owner needs to contact their Cvent representative. If the client would like to do a test using their Sandbox account, the Push API must also be enabled on the Sandbox instance. More info
If using webhooks for sending registration data from Cvent to Touchcast is not an option, it is still possible to enable integration and pass the data via APIs (REST APIs; SOAP APIs option will be deprecated starting April 2022 as eventually Cvent will stop supporting it).
It should not be advised though due to the frequency of data synchronization (see below) and the webhook usage should be the preferred method.
Data Synchronization
The frequency of data syncing from Cvent to Touchcast:
Via Webhook - ~5-15 minutes. For example, if an attendee registers on Cvent, they will be able to log in to the Touchcast page in approximately 5 minutes after registration on Cvent.
Via APIs - ~ 30 minutes. If the attendee registers on Cvent, they will be able to log in to Touchcast within 30 minutes.
Can also manually update to reduce this wait time.
Data sync for participation tracking (from Touchcast to Cvent) happens with a 5-15 minutes delay.
Example of Use Cases
Attendees are registered through Cvent Registration and they will need to log in to Touchcast to watch the event/network during the event. All attendees have the same level of access/ agenda.
Attendees are registered through Cvent and they will need to log in to Touchcast to watch the event/network during the event. Attendees are grouped by custom access to tracks/sessions, each attendee is assigned only one group (track).
Event Manager wants the Participation Status of attendee on Cvent to be updated automatically when a certain criteria is triggered on the Touchcast page.
Connecting the Events Between Cvent and Touchcast
Using Webhook
On Touchcast:
Go to Showtime Settings -> Integrations -> Cvent.
Expand the tab and select the checkbox.
Choose the environment:
If you have a Cvent Sandbox account and want to test this integration on a mock event, use the Sandbox option.
If you want to plug data from a real Cvent event, choose Production.
Cvent API type - select NONE from the dropdown, if you don’t need to use REST APIs for Participation tracking.
Cvent event ID - this is the same thing as eCode and here is how it can be retrieved.
Enable Cvent Webhook
On Cvent:
Go to My Profile -> Integrations -> Push API Integrations (note that webhook must be enabled for the Cvent account for this).
Create integration
Name - create a relevant name, e.g. Touchcast Summit
Type - Webhooks
Default Endpoint - copy the link from the Touchcast webhook endpoint field
Connection type - Token based
Copy authentication token from Touchcast and paste into the authentication token field
Synced Objects
Attendees - yes
Sessions - no
Speakers - no
Integration points - select and keep the following:
Invitee/Guest Event Registration Cancelled
Invitee/Guest Event Registration Modified
Invitee/Guest Registered for Event
Go back to the list of events and select your event.
Select Integrations - Push API integrations
Add Webhook - select the webhook that was created.
Using REST APIs (Participation Tracking)
REST APIs should be used when the participation status of event attendees on Showtime needs to be automatically passed and updated on Cvent.
This should be done in combination with enabling webhook for receiving registration data from Cvent (see above).
To enable REST APIs, the event planner will need to invite Touchcast developers to the Cvent workspace. Read more about it on Cvent.
Step-by-step instructions.
On Cvent:
Make sure REST APIs are enabled for the Cvent account.
From Cvent Admin click Integrations -> REST API
In the new tab that opens click Manage API access
Create Workspace - select the data that you would like your developers to have access to in their applications.
Invite Touchcast developers to join the workspace. Contact your Touchcast representative to find out this information.
The Touchcast developers will create the application to ensure this integration.
On Touchcast:
Select REST in the Cvent API Type dropdown
Fill out the Cvent event ID- this is the same thing as eCode and here is how it can be retrieved
Cvent Client ID and Secret - retrieve this information from the Application that Touchcast developers created OR ask Touchcast to provide it.
Participation tracking - select the one that fits your use case
On login - the attendee will be considered a participant as soon as they log in to the Touchcast event page.
X minutes after login - the attendee will be considered a participant X minutes after they log in to the Touchcast event page.
Participation Duration, minutes
X minutes of watched videos
Showtime Integration Settings - Cvent
Once the integration is running, and the criterion set for participation is met, the status of Attendee on Cvent will be automatically changed from “Event Participant - No“ to “Event Participant - Yes“ under Attendees → Attendee List section.
Mapping the Fields
Default fields
The following fields are mapped by default. You don’t need to make any manual adjustments for these fields to pass from Cvent into Touchcast:
Cvent | Touchcast |
FirstName | First Name |
LastName | Last Name |
EmailAddress | |
Company | Company |
Title | Job Title |
Profile Image URL | Profile Image |
However, if some of the fields need to be unmapped, it is possible to do that (all except email and Profile Image URL).
Additional fields
The following additional fields are available for manual mapping. That is, if you want to pass any of the fields below from Cvent to Touchcast, you will need to create a field on Touchcast and select the Cvent field to map it to from the dropdown. Depending on whether you are using webhook or REST API’s the list of these fields will be different.
Webhook:
Status
RegistrationType
RegistrationDate
CanceledDate
LastModifiedDate
ContactId
InviteeId
SourceId
CCEmailAddress
WorkPhone
EventId
EventCode
EventTitle
GroupLeader
Credit
InternalNote
InvitedBy
ConfirmationNumber
RegistrationTypeCode
ReferenceId
QuestionId
QuestionCode
Answer
GuestDetail
GuestId
MiddleName
Phone
EmailAddress
OrderDetail
OrderDetailItemId
OrderDetailId
OrderNumber
ProductName
Quantity
Amount
AmountPaid
AmountDue
Participant
WorkAddress1
WorkAddress2
WorkAddress3
WorkCity
WorkState
WorkStateCode
WorkPostalCode
WorkCountry
Gender
Rest APIs:
RegistrationType
RegistrationDate
LastModifiedDate
ContactId
FirstName
LastName
Company
Title
CCEmailAddress
WorkPhone
SourceId
EventId
GroupLeader
InvitedBy
ConfirmationNumber
RegistrationTypeCode
ReferenceId
QuestionId
MiddleName
Phone
EmailAddress
ConfirmationNumber
To create the additional field on Touchcast, go to Users -> Registration fields -> Add a field:
Create a field label
Define the field type - you will use Textbox in the majority of cases
Skip Field Placeholder and Mandatory checkbox
Display on Profile - check this box if you are enabling user profiles for the event and want this field to be displayed on the user profile on Touchcast. If not checked, the field will still come through and be populated in the CMS
Cvent property - choose the desired field from the dropdown
Skip the Choose step field
Save
Custom fields
Custom fields can be used for the Cvent Registration. They do not appear in the Cvent property dropdown from the section above unless manually added.
If there is a need to use a custom field, use the following instructions:
Create the field on Cvent. Copy the field name exactly as it is.
Go to the Integrations tab.
Under Cvent custom fields add the new field and paste the copied name exactly as they appear on Cvent.
Go to the Registration fields.
Add a field.
Complete steps from the Additional fields section - your newly added custom fields will appear in the dropdown at the very bottom of the list.
Managing Custom Access
If custom access to the event content can be managed through Registration Types on Cvent, it’s possible to connect each registration type to one custom access group on Touchcast.
For example, if all attendees are tied to one of the tracks: either EMEA or Atlantic, this can be managed via Registration types.
In order for this to work, Registration types must be set up on Cvent first. To complete the setup on Touchcast:
Go to the Integrations tab
Under Cvent Registration Types add the new fields and paste the Registration Type names exactly as they appear on Cvent.
Go to User Management -> Groups.
Create a group.
Map the group to the Registration type from the dropdown.
When registration types are mapped to custom access groups, it is applied to both Agenda Groups and Resources Groups. Implemented with v2.2
Integration in Action
Once the integration is set up, the new registrants data will start coming through into the Allowlist Emails tab on Touchcast:
In order to import all the existing registrations into Touchcast (in case they happened prior to setting up the integration) there is an option on Cvent to manually push out all registrations that should be used.
If the attendee cancels their registration on Cvent, their status on Touchcast will be changed to Pending and they will lose access to the event page.
Out of Scope/Next Versions
Integrations on the sessions or speakers level.