Eventfinity Dashboard Helpsite Dashboard Help Site

Contact Us

Client Cvent API Registration Integrations

Updated September 18, 2024

Overview

Eventfinity can integrate registration data from Cvent to seamlessly import event attendees in a safe and secure process. Cvent offers both SOAP and REST APIs and Eventfinity can be set up using either version.

Choosing Cvent SOAP vs REST API

SOAP (Simple Object Access Protocol) and REST (Representational State Transfer) are both web service communication protocols. SOAP is more standardized, has more security features, and works well behind corporate firewalls and proxies. REST is more flexible and can handle a wider variety of data formats, using less bandwidth and, therefore, a little faster. 

Most client’s data security teams usually have a preference for which protocol to use. It is recommended that clients consult with their organization’s data security team and talk with their Cvent representative about which protocol is best for their event. 

Getting Started with Integrations

Gramercy Tech clients should work with the integration provider Cvent to set up their API account to establish a connection with Eventfinity. The client then provides Gramercy the following information:

Additionally, clients will need to provide the integration provider with a list of Eventfinity IP addresses to be whitelisted. Your Gramercy Account manager can provide this information once the site is created. This list may change over time as Gramercy scales our servers up (meaning more IP addresses) or down based on our overall customer needs.

Setting up the Data

Once the client creates the API account, Gramercy will need the data labels required for the Eventfinity site or native application. This information should contain the data set's common name and the API database column heading. Below is an example of common data sets.

Data Label Column Name
API Data Label Column Heading
First NameQuestion ID: reg_FirstName   reg_FirstName
Last NameQuestion ID: reg_LastName   reg_LastName
Login EmailQuestion ID: reg_EmailAddress  reg_EmailAddress
CompanyQuestion ID: reg_Company  reg_Company
Job TitleQuestion ID: reg_Title  reg_Title
StateQuestion ID: 0F58F054-706A-4962-887D-F5505A75E45D  Custom Detail - State
CountryQuestion ID: 00D0C9BA-345B-49C-13BCDEC9FA43  Registrant Survey - Country
LanguageQuestion ID: B349F8CE-87FF-4253-B7EF-005894757C37   reg_language

Before Registration Opens - Testing

To ensure that the data from the importer is flowing correctly, some test attendee data should be entered into the registration site. The client should enter sample data for 5-10 test attendees. Once the test registrations are done, the data should be exported into a CSV or appropriate spreadsheet file and provided to Gramercy. 

Upon receipt of the file, Gramercy will perform a test import to ensure the information is imported correctly. Once the successful data transfer is confirmed, Gramercy will notify the client and registration can officially open.

After registration opens - monitoring

Once registration is open, the client should monitor the site at regular intervals to compare the total number of attendees to those imported into the Eventfinity event. This type of information can be shared/validated as part of the regularly scheduled production calls. 

Additional Security - Whitelisting EF IP Addresses

Some clients will require additional security for accessing data from Cvent. Consult with the Gramercy back-end team for a list of current Gramercy IP addresses that will be making calls to Cvent. These IP addresses should be provided to the client for incorporation into Cvent. 

NOTE: Gramercy’s IP addresses may scale up or down depending on the number of servers we utilize for any given week—based on the number and size of events we are hosting during a given period. If your IP addresses are whitelisted, be sure to alert your Cvent contact if our IP list increases. 

REST API Permissions

Your Cvent token should be scoped to have the permissions in the table below.

Permissions
API endpoint and why we need
bulk/bulk-jobs:write
event/attendees:write
https://api-platform.cvent.com/ea/bulk-jobs/events/{id}/check-in
Batch updating a group of attendees as checked-in or attended in Cvent
event/attendees:readhttps://api-platform.cvent.com/ea/attendees/filter
https://api-platform.cvent.com/ea/attendees/{id}

Getting an event’s attendee list and getting specific attendees
event/sessions:read
https://api-platform.cvent.com/ea/sessions/filter
Importing Cvent sessions as agenda items into Eventfinity
event/session-enrollment:readhttps://api-platform.cvent.com/ea/sessions/enrollment
Importing in Eventfinity attendee record if an attendee is enrolled for Cvent sessions
event/custom-fields:readhttps://api-platform.cvent.com/ea/custom-fields
Getting an event’s custom questions and fields for the 3rd party keys linking
event/events:readhttps://api-platform.cvent.com/ea/event-questions
Getting an event’s event-specific questions for the 3rd party keys linking