The CData Sync App provides a straightforward way to continuously pipeline your Cvent data to any database, data lake, or data warehouse, making it easily available for Analytics, Reporting, AI, and Machine Learning.
The Cvent connector can be used from the CData Sync application to pull data from Cvent and move it to any of the supported destinations.
The Sync App leverages the Cvent REST API to enable bidirectional access to Cvent objects.
For required properties, see the Settings tab.
For connection properties that are not typically required, see the Advanced tab.
The Cvent REST API uses the client credentials flow of OAuth 2.0 to authorize requests to the Cvent.
Before you can authenticate to Cvent, you must create a workspace and an OAuth application.
After creating an OAuth application, set the following connection properties to connect to Cvent:
This section shows the available API objects and provides more information on executing SQL to Cvent APIs.
Tables expose Cvent entities like events, contacts, and sessions.
Views are read-only tables that expose Cvent entities like emails, budget totals, and event questions.
Stored Procedures are function-like interfaces to Cvent. Stored procedures allow you to execute operations to Cvent, including obtaining and refreshing OAuth tokens.
JSON is the accepted format for updating or inserting data for Cvent tables that contain aggregate values.
Below is an example of the HomeAddressAggregate field data from the Contacts table.
INSERT INTO Contacts (firstName, lastName, email, HomeAddressAggregate) VALUES ('CventContactFirstName', 'CventContactLastName', '[email protected]', '{"regionCode": "TX"," "address1": "Cvent Inc.", "address2": "4001 West Parmer Lane", "address3": "PO Box 123", "city": "Austin", "countryCode": "US", "postalCode": "78727"}')
The Sync App models the data in Cvent as a list of tables in a relational database that can be queried using standard SQL statements.
| Name | Description |
| AttendeeActivities | Returns data from the AttendeeActivities table. |
| Attendees | Returns data from the Attendees table. |
| BudgetItems | Returns data from the BudgetItems table. |
| ContactGroups | Returns data from the ContactGroups table. |
| Contacts | Returns data from the Contacts table. |
| CustomFields | Returns data from the CustomFields table. |
| Events | Returns data from the Events table. |
| EventTransactions | Returns data from the EventTransactions table. |
| Exhibitors | Returns data from the Exhibitor table. |
| Sessions | Returns data from the Sessions table. |
| Speakers | Returns data from the Speakers table. |
| Users | Returns data from the Users table. |
Returns data from the AttendeeActivities table.
The Cvent API allows you to filter by certain fields when querying for data. The following fields can be filtered by the API:
All other filters are handled client-side.
The following is an example of a SELECT statement:
SELECT * FROM AttendeeActivities WHERE Id='cventId' OR Created <= '06/11/2020'
INSERT INTO AttendeeActivities (name, type, dataid, dataExternalActivityDate, attendeeId, eventId)
VALUES ('social.media', 'event.external', 'e1188b76-74e7-406a-aeec-c841e52dbc11', '01/02/2024', '97bb14d0-69ce-40a3-be66-0a888542978c', 'e1188b76-74e7-406a-aeec-c841e52dbc11' )
| Name | Type | ReadOnly | References | Description |
| Name | String | False |
The Name of the AttendeeActivities table. | |
| Type | String | False |
The Type of the AttendeeActivities table. | |
| Id [KEY] | String | False |
The Id of the AttendeeActivities table. | |
| Created | Datetime | False |
The Created of the AttendeeActivities table. | |
| AppointmentId | String | False |
The AppointmentId of the AttendeeActivities table. | |
| AppointmentName | String | False |
The AppointmentName of the AttendeeActivities table. | |
| AppointmentCode | String | False |
The AppointmentCode of the AttendeeActivities table. | |
| ContactFirstName | String | False |
The ContactFirstName of the AttendeeActivities table. | |
| ContactLastName | String | False |
The ContactLastName of the AttendeeActivities table. | |
| ContactEmail | String | False |
The ContactEmail of the AttendeeActivities table. | |
| AttendeeId | String | False |
The AttendeeId of the AttendeeActivities table. | |
| EventId | String | False |
The EventId of the AttendeeActivities table. | |
| EventCode | String | False |
The EventCode of the AttendeeActivities table. | |
| EventTimezone | String | False |
The EventTimezone of the AttendeeActivities table. | |
| EventTitle | String | False |
The EventId of the AttendeeActivities table. | |
| DataId | String | False |
The DataId of the Attendess table. | |
| DataExternalActivityDate | Datetime | False |
The DataExternalActivityDate of the Attendess table. |
Returns data from the Attendees table.
The Cvent API allows you to filter by certain fields when querying for data. The following fields can be filtered by the API:
All other filters are handled client-side.
The following is an example of a SELECT statement:
SELECT * FROM Attendees WHERE Id='cventId' OR RegistrationLastModified <= '06/11/2020'
INSERT INTO Attendees (status, ContactId, EventId, InvitationListId)
VALUES('No Response', 'DE830CBE-B4EB-4E2B-A51C-6F10384CD0AD', 'e0ce6b11-2c5c-48b2-8104-b71ace5eed13', 'be48a15b-f86f-458f-a7e5-45c9bc073030')
UPDATE Attendees SET status = 'Accepted', ContactId = 'DE830CBE-B4EB-4E2B-A51C-6F10384CD0AD', EventId='e0ce6b11-2c5c-48b2-8104-b71ace5eed13' WHERE ID='462af84e-be35-4082-ac38-3cda475dd1de'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | False |
The ID of the Attendees table. | |
| ConfirmationNumber | String | False |
The ConfirmationNumber of the Attendees table. | |
| CheckedIn | Boolean | False |
The CheckedIn of the Attendees table. | |
| CheckIn | Datetime | False |
The CheckIn of the Attendees table. | |
| CheckOut | Datetime | False |
The CheckOut of the Attendees table. | |
| Duration | String | False |
The Duration of the Attendees table. | |
| ReferenceId | String | False |
The ReferenceId of the Attendees table. | |
| Note | String | False |
The Note of the Attendess table. | |
| Guest | String | False |
The Guest of the Attendess table. | |
| PrimaryId | String | False |
The PrimaryId of the Attendess table. | |
| Unsubscribed | String | False |
The Unsubscribed of the Attendess table. | |
| Status | String | False |
The Status of the Attendess table. | |
| RegisteredAt | Datetime | False |
The RegisteredAt of the Attendess table. | |
| RegistrationLastModified | Datetime | False |
The RegistrationLastModified of the Attendess table. | |
| RegistrationCancelledAt | Datetime | False |
The RegistrationCancelledAt of the Attendess table. | |
| InvitedBy | String | False |
The InvitedBy of the Attendess table. | |
| ResponseMethod | String | False |
The ResponseMethod of the Attendess table. | |
| Visibility | String | False |
The Visibility of the Attendess table. | |
| Bio | String | False |
The Bio of the Attendess table. | |
| ShowPopupNotification | String | False |
The ShowPopupNotification of the Attendess table. | |
| WebsiteUrl | String | False |
The WebsiteUrl of the Attendess table. | |
| AllowPushNotifications | String | False |
The AllowPushNotifications of the Attendess table. | |
| AllowAppointmentPushNotifications | String | False |
The AllowAppointmentPushNotifications of the Attendess table. | |
| TestRecord | String | False |
The TestRecord of the Attendess table. | |
| AttendeeLastModified | Datetime | False |
The AttendeeLastModified of the Attendess table. | |
| Created | Datetime | False |
The Created of the Attendess table. | |
| CreatedBy | String | False |
The CreatedBy of the Attendess table. | |
| LastModified | Datetime | False |
The LastModified of the Attendess table. | |
| LastModifiedBy | String | False |
The LastModifiedBy of the Attendess table. | |
| EventId | String | False |
The EventId of the Attendess table. | |
| ContactId | String | False |
The ContactId of the Attendess table. | |
| ContactFirstName | String | False |
The ContactFirstName of the Attendess table. | |
| ContactLastName | String | False |
The ContactLastName of the Attendess table. | |
| ContactEmail | String | False |
The ContactEmail of the Attendess table. | |
| RegistrationPathId | String | False |
The RegistrationPathId of the Attendess table. | |
| RegistrationPathCode | String | False |
The RegistrationPathCode of the Attendess table. | |
| RegistrationPathName | String | False |
The RegistrationPathName of the Attendess table. | |
| InvitationListId | String | False |
The InvitationListId of the Attendess table. | |
| InvitationListName | String | False |
The InvitationListName of the Attendess table. | |
| WebLinksAcceptRegistration | String | False |
The WebLinksAcceptRegistration of the Attendess table. | |
| WebLinksDeclineRegistration | String | False |
The WebLinksDeclineRegistration of the Attendess table. | |
| RegistrationId | String | False |
The RegistrationId of the Attendess table. | |
| RegistrationName | String | False |
The RegistrationName of the Attendess table. | |
| ExternalReferencesAggregate | String | False |
The ExternalReferencesAggregate of the Attendess table. | |
| GroupId | String | False |
The GroupId of the Attendess table. | |
| GroupMember | Boolean | False |
The GroupMember of the Attendess table. | |
| GroupLeader | Boolean | False |
The GroupLeader of the Attendess table. | |
| QuestionsAggregate | String | False |
The QuestionsAggregate of the Attendess table. | |
| AnswersAggregate | String | False |
The AnswersAggregate of the Attendess table. | |
| AdmissionItemId | String | False |
The AdmissionItemId of the Attendess table. | |
| AdmissionItemCode | String | False |
The AdmissionItemCode of the Attendess table. | |
| AdmissionItemName | String | False |
The AdmissionItemName of the Attendess table. | |
| AppointmentGroupsAggregate | String | False |
The AppointmentGroupsAggregate of the Attendess table. |
Returns data from the BudgetItems table.
The Cvent API allows you to filter by certain fields when querying for data. The following fields can be filtered by the API:
All other filters are handled client-side.
The following is an example of a SELECT statement:
select * from BudgetItems where Id='cventId' or Date <= '06/11/2020'
String costDetail = '[
{
\id\: \281d7a8b-f525-4658-9268-5ea73c97a54e\,
ame\: \Budgeted\,
\units\: 1.0,
\cost\: 500.0,
\gratuityDetail\: {
\gratuity\: 0.0,
\appliedGratuityValue\: 0.0
},
\taxDetail\: [],
\totalCost\: 500.0
},
{
\id\: \d8cbab1a-e370-43b9-afde-a097c81e20e1\,
ame\: egotiated\,
\units\: 1.0,
\cost\: 400.0,
\gratuityDetail\: {
\gratuity\: 0.0,
\appliedGratuityValue\: 0.0
},
\taxDetail\: [],
\totalCost\: 400.0
},
{
\id\: \0ca4467a-5843-4204-8c26-452680b04b27\,
ame\: \Revision1\,
\units\: 1.0,
\cost\: 424.0,
\gratuityDetail\: {
\gratuity\: 0.0,
\appliedGratuityValue\: 0.0
},
\taxDetail\: [],
\totalCost\: 424.0
},
{
\id\: \10cc5cef-a4f3-4474-bb9d-0c0c7110b351\,
ame\: \Revision2\,
\units\: 1.0,
\cost\: 455.0,
\gratuityDetail\: {
\gratuity\: 0.0,
\appliedGratuityValue\: 0.0
},
\taxDetail\: [],
\totalCost\: 455.0
},
{
\id\: \2eec2b68-808d-4bab-a061-b4fafc3300dc\,
ame\: \Actual\,
\units\: 1.0,
\cost\: 455.0,
\gratuityDetail\: {
\gratuity\: 0.0,
\appliedGratuityValue\: 0.0
},
\taxDetail\: [],
\totalCost\: 455.0
}
]';
INSERT INTO budgetitems (EventId, costType, name, Status, Date, costIncludesTaxGratuity, calculateTaxOnGratuity, gratuityType, currency, conversionRate, CategoryId, CategoryName, costDetailAggregate)
VALUES('0ac85e1d-ef51-43a0-a4cf-773b64b1c6f9', 'FIXED', 'Airport Transportation', 'ESTIMATED', '2020-02-07T00:00:00.00Z', false, true, 'PERCENTAGE', 'USD', '5.2', '3', 'Travel', costDetail)
Update BudgetItems SET costType='FIXED', name='Airport Transportation', CategoryId='3',
CategoryName='Travel', status='PAID', date='2024-02-07T00:00:00.00Z', costIncludesTaxGratuity='false',
calculateTaxOnGratuity='true' , gratuityType='PERCENTAGE', currency='USD', conversionRate='5.2',costDetailAggregate=costDetail
where EventId='0ac85e1d-ef51-43a0-a4cf-773b64b1c6f9' and id='eb07a054-71a5-49a5-9773-064c3b9ec507'
| Name | Type | ReadOnly | References | Description |
| Deleted | Boolean | False |
The Deleted of the BudgetItems table. | |
| Id [KEY] | String | False |
The Id of the BudgetItems table. | |
| CostType | String | False |
The CostType of the BudgetItems table. | |
| Name | String | False |
The Name of the BudgetItems table. | |
| Code | String | False |
The Code of the BudgetItems table. | |
| Status | String | False |
The Status of the BudgetItems table. | |
| Date | Datetime | False |
The Date of the BudgetItems table. | |
| LastModifiedDate | Datetime | False |
The LastModifiedDate of the BudgetItems table. | |
| CostIncludesTaxGratuity | Boolean | False |
The CostIncludesTaxGratuity of the BudgetItems table. | |
| CalculateTaxOnGratuity | Boolean | False |
The CalculateTaxOnGratuity of the BudgetItems table. | |
| GratuityType | String | False |
The GratuityType of the BudgetItems table. | |
| InternalNote | String | False |
The InternalNote of the BudgetItems table. | |
| Currency | String | False |
The Currency of the BudgetItems table. | |
| ConversionRateLocked | String | False |
The ConversionRateLocked of the BudgetItems table. | |
| ConversionRate | String | False |
The ConversionRate of the BudgetItems table. | |
| AssociatedSession | String | False |
The AssociatedSession of the BudgetItems table. | |
| CategoryId | String | False |
The CategoryId of the BudgetItems table. | |
| CategoryName | String | False |
The CategoryName of the BudgetItems table. | |
| SubCategoryId | String | False |
The SubCategoryId of the BudgetItems table. | |
| SubCategoryName | String | False |
The SubCategoryName of the BudgetItems table. | |
| VendorId | String | False |
The VendorId of the BudgetItems table. | |
| VendorName | String | False |
The VendorName of the BudgetItems table. | |
| VendorType | String | False |
The VendorType of the BudgetItems table. | |
| GeneralLedgerId | String | False |
The GeneralLedgerId of the BudgetItems table. | |
| GeneralLedgerCode | String | False |
The GeneralLedgerCode of the BudgetItems table. | |
| GeneralLedgerName | String | False |
The GeneralLedgerName of the BudgetItems table. | |
| CostAvoidanceAmount | Double | False |
The CostAvoidanceAmount of the BudgetItems table. | |
| CostAvoidanceDescription | String | False |
The CostAvoidanceDescription of the BudgetItems table. | |
| CostDetailAggregate | String | False |
The CostDetailAggregate of the BudgetItems table. | |
| SavingsAggregate | String | False |
The SavingsAggregate of the BudgetItems table. | |
| AssociatedRegistrantsAggregate | String | False |
The AssociatedRegistrantsAggregate of the BudgetItems table. | |
| EventId [KEY] | String | False |
Events.Id |
The EventId of the BudgetItems table. |
Returns data from the ContactGroups table.
The Cvent API allows you to filter by certain fields when querying for data. The following fields can be filtered by the API:
All other filters are handled client-side.
The following is an example of a SELECT statement:
SELECT * from ContactGroups where Name='new'
INSERT INTO ContactGroups (Name, Type) VALUES ('Test 2', 'STANDARD')
UPDATE ContactGroups SET Id ='fa47f767-3a45-44dc-a7a5-701f42a6cccd', Name='abc', Type = 'DISTRIBUTION_LIST' WHERE Id ='fa47f767-3a45-44dc-a7a5-701f42a6cccd'
DELETE FROM ContactGroups WHERE Id='fa3ca656-a6cb-498d-9b54-25bba92cf931'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | False |
The Id of the ContactGroups table. | |
| Name | String | False |
The Name of the ContactGroups table. | |
| ShortDescription | String | False |
The ShortDescription of the ContactGroups table. | |
| Description | String | False |
The Description of the ContactGroups table. | |
| Type | String | False |
The Type of the ContactGroups table. | |
| Note | String | False |
The Note of the ContactGroups table. | |
| Created | Datetime | False |
The Created of the ContactGroups table. | |
| CreatedBy | String | False |
The CreatedBy of the ContactGroups table. | |
| LastModified | Datetime | False |
The LastModified of the ContactGroups table. | |
| LastModifiedBy | String | False |
The LastModifiedBy of the ContactGroups table. | |
| DistributionSecurityType | String | False |
The DistributionSecurityType of the ContactGroups table. | |
| DistributionInternalNote | String | False |
The DistributionInternalNote of the ContactGroups table. | |
| DistributionStatus | String | False |
The DistributionStatus of the ContactGroups table. |
Returns data from the Contacts table.
The Cvent API allows you to filter by certain fields when querying for data. The following fields can be filtered by the API:
All other filters are handled client-side.
The following is an example of a SELECT statement:
SELECT * FROM Contacts WHERE LastName='lastNameValue' OR Created <= '06/11/2020'
INSERT INTO Contacts (firstName, lastName, email, HomeAddressAddress1, HomeAddressCity, HomeAddressCountry)
VALUES('MateoMateov222', 'Villa2sds2222', '[email protected]', 'address1val', 'cityVal', 'countryVal')
UPDATE Contacts SET firstName= 'updatedFirstName' WHERE id = '80B7A193-A807-4B7E-BFEA-787E86DFB40D'
DELETE FROM Contacts WHERE id = '80B7A193-A807-4B7E-BFEA-787E86DFB40D'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | False |
The Id of the Contacts table. | |
| ParentId | String | False |
The ParentId of the Contacts table. | |
| FirstName | String | False |
The FirstName of the Contacts table. | |
| LastName | String | False |
The LastName of the Contacts table. | |
| MiddleName | String | False |
The MiddleName of the Contacts table. | |
| Nickname | String | False |
The Nickname of the Contacts table. | |
| String | False |
The Email of the Contacts table. | ||
| CcEmail | String | False |
The CcEmail of the Contacts table. | |
| Gender | String | False |
The Gender of the Contacts table. | |
| Company | String | False |
The Company of the Contacts table. | |
| Designation | String | False |
The Designation of the Contacts table. | |
| Title | String | False |
The Title of the Contacts table. | |
| PrimaryAddressType | String | False |
The PrimaryAddressType of the Contacts table. | |
| HomePhone | String | False |
The HomePhone of the Contacts table. | |
| HomeFax | String | False |
The HomeFax of the Contacts table. | |
| WorkPhone | String | False |
The WorkPhone of the Contacts table. | |
| WorkFax | String | False |
The WorkFax of the Contacts table. | |
| SourceId | String | False |
The SourceId of the Contacts table. | |
| MobilePhone | String | False |
The MobilePhone of the Contacts table. | |
| Prefix | String | False |
The Prefix of the Contacts table. | |
| Pager | String | False |
The Pager of the Contacts table. | |
| Deleted | Boolean | False |
The Deleted of the Contacts table. | |
| Npi | String | False |
The Npi of the Contacts table. | |
| DateOfBirth | Datetime | False |
The DateOfBirth of the Contacts table. | |
| PassportNumber | String | False |
The PassportNumber of the Contacts table. | |
| SocialSecurityNumber | String | False |
The SocialSecurityNumber of the Contacts table. | |
| NationalIdentificationNumber | String | False |
The NationalIdentificationNumber of the Contacts table. | |
| Headline | String | False |
The Headline of the Contacts table. | |
| PersonalWebsite | String | False |
The PersonalWebsite of the Contacts table. | |
| Biography | String | False |
The Biography of the Contacts table. | |
| Pronouns | String | False |
The Pronouns of the Contacts table. | |
| Created | Datetime | False |
The Created of the Contacts table. | |
| CreatedBy | String | False |
The CreatedBy of the Contacts table. | |
| LastModified | Datetime | False |
The LastModified of the Contacts table. | |
| LastModifiedBy | String | False |
The LastModifiedBy of the Contacts table. | |
| EventId | String | False |
The EventId of the Contacts table. | |
| TypeId | String | False |
The TypeId of the Contacts table. | |
| TypeName | String | False |
The TypeName of the Contacts table. | |
| MembershipType | String | False |
The MembershipType of the Contacts table. | |
| MembershipPlan | String | False |
The MembershipPlan of the Contacts table. | |
| MembershipJoined | String | False |
The MembershipJoined of the Contacts table. | |
| MembershipExpiration | String | False |
The MembershipExpiration of the Contacts table. | |
| MembershipLastRenewal | String | False |
The MembershipLastRenewal of the Contacts table. | |
| MembershipAmountDue | String | False |
The MembershipAmountDue of the Contacts table. | |
| MembershipListInDirectory | String | False |
The MembershipListInDirectory of the Contacts table. | |
| HomeAddressRegion | String | False |
The HomeAddressRegion of the Contacts table. | |
| HomeAddressRegionCode | String | False |
The HomeAddressRegionCode of the Contacts table. | |
| HomeAddressCountry | String | False |
The HomeAddressCountry of the Contacts table. | |
| HomeAddressAddress1 | String | False |
The HomeAddressAddress1 of the Contacts table. | |
| HomeAddressAddress2 | String | False |
The HomeAddressAddress2 of the Contacts table. | |
| HomeAddressAddress3 | String | False |
The HomeAddressAddress3 of the Contacts table. | |
| HomeAddressCity | String | False |
The HomeAddressCity of the Contacts table. | |
| HomeAddressCountryCode | String | False |
The HomeAddressCountryCode of the Contacts table. | |
| HomeAddressPostalCode | String | False |
The HomeAddressPostalCode of the Contacts table. | |
| WorkAddressRegion | String | False |
The WorkAddressRegion of the Contacts table. | |
| WorkAddressRegionCode | String | False |
The WorkAddressRegionCode of the Contacts table. | |
| WorkAddressCountry | String | False |
The WorkAddressCountry of the Contacts table. | |
| WorkAddressAddress1 | String | False |
The WorkAddressAddress1 of the Contacts table. | |
| WorkAddressAddress2 | String | False |
The WorkAddressAddress2 of the Contacts table. | |
| WorkAddressAddress3 | String | False |
The WorkAddressAddress3 of the Contacts table. | |
| WorkAddressCity | String | False |
The WorkAddressCity of the Contacts table. | |
| WorkAddressCountryCode | String | False |
The WorkAddressCountryCode of the Contacts table. | |
| WorkAddressPostalCode | String | False |
The WorkAddressPostalCode of the Contacts table. | |
| ComplianceAggregate | String | False |
The ComplianceAggregate of the Contacts table. | |
| OptOutOptedOut | String | False |
The OptOutDate of the Contacts table. | |
| OptOutDate | String | False |
The OptOut of the Contacts table. | |
| OptOutBy | String | False |
The OptOut of the Contacts table. |
Returns data from the CustomFields table.
The Cvent API allows you to filter by certain fields when querying for data.
The following is an example of a SELECT statement:
select * from CustomFields where Id='lastNameValue' or LastModified <= '06/11/2020'The following is an example of an INSERT statement:
INSERT INTO CustomFields (category, name, code, type)
VALUES('Contact', 'Villa2sds2222', 'customfieldName', 'uniqueCode', 'cityVal', 'Open Ended Text - Comment Box')
The following is an example of an UPDATE statement:
UPDATE CustomFields SET name= 'updatedFirstName' where id = '80B7A193-A807-4B7E-BFEA-787E86DFB40D'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | False |
The Id of the CustomFields table. | |
| Category | String | False |
The Category of the CustomFields table. | |
| Name | String | False |
The Name of the CustomFields table. | |
| Code | String | False |
The Code of the CustomFields table. | |
| Required | Boolean | False |
The Required of the CustomFields table. | |
| Type | String | False |
The Type of the CustomFields table. | |
| Order | String | False |
The Order of the CustomFields table. | |
| HelpText | String | False |
The HelpText of the CustomFields table. | |
| DisplayInDataTag | String | False |
The DisplayInDataTag of the CustomFields table. | |
| DefaultTagText | String | False |
The DefaultTagText of the CustomFields table. | |
| ConsentField | Boolean | False |
The ConsentField of the CustomFields table. | |
| DisplayInEventCreationWizard | Boolean | False |
The DisplayInEventCreationWizard of the CustomFields table. | |
| Created | Datetime | False |
The Created of the CustomFields table. | |
| CreatedBy | String | False |
The CreatedBy of the CustomFields table. | |
| LastModified | Datetime | False |
The LastModified of the CustomFields table. | |
| LastModifiedBy | String | False |
The LastModifiedBy of the CustomFields table. | |
| DetailsAnswerFormat | String | False |
The DetailsAnswerFormat of the CustomFields table. | |
| DetailsMinimum | String | False |
The DetailsMinimum of the CustomFields table. | |
| DetailsMaximum | String | False |
The DetailsMaximum of the CustomFields table. |
Returns data from the Events table.
The Cvent API allows you to filter by certain fields when querying for data. The following fields can be filtered by the API:
All other filters are handled client-side.
The following is an example of a SELECT statement:
SELECT * FROM Events WHERE Title='titleValue' OR Start <= '06/11/2020'
@languagesAggregate = '[en-US, en-psk]'
@plannersAggregate = '[{firstName: John, lastName: Doe, email: [email protected] }]'
INSERT INTO Events (Title, format, timezone, LanguagesAggregate, PlannersAggregate, type) VALUES('SampleTitle', 'Virtual', 'America/New_York' , @languagesAggregate, @plannersAggregate, 'Webinar')
UPDATE Events SET title= 'EventTitle',format= 'Virtual',timezone= 'America/Chicago',LanguagesAggregate= @languagesAggregate,PlannersAggregate= @plannersAggregate, type='Celebration' WHERE id = '80B7A193-A807-4B7E-BFEA-787E86DFB40D'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | False |
The Id of the Events table. | |
| Title | String | False |
The Title of the Events table. | |
| Code | String | False |
The Code of the Events table. | |
| Virtual | Boolean | False |
The Virtual of the Events table. | |
| Format | String | False |
The Format of the Events table. | |
| Description | String | False |
The Description of the Events table. | |
| Start | Datetime | False |
The Start of the Events table. | |
| End | Datetime | False |
The End of the Events table. | |
| CloseAfter | Datetime | False |
The CloseAfter of the Events table. | |
| ArchiveAfter | Datetime | False |
The ArchiveAfter of the Events table. | |
| LaunchAfter | Datetime | False |
The LaunchAfter of the Events table. | |
| Timezone | String | False |
The Timezone of the Events table. | |
| Phone | String | False |
The Phone of the Events table. | |
| Note | String | False |
The Note of the Events table. | |
| DefaultLocale | String | False |
The DefaultLocale of the Events table. | |
| Currency | String | False |
The Currency of the Events table. | |
| RegistrationSecurityLevel | String | False |
The RegistrationSecurityLevel of the Events table. | |
| Status | String | False |
The Status of the Events table. | |
| EventStatus | String | False |
The EventStatus of the Events table. | |
| PlanningStatus | String | False |
The PlanningStatus of the Events table. | |
| TestMode | Boolean | False |
The TestMode of the Events table. | |
| Capacity | Integer | False |
The Capacity of the Events table. | |
| Type | String | False |
The Type of the Events table. | |
| Created | Datetime | False |
The Created of the Events table. | |
| LastModified | Datetime | False |
The LastModified of the Events table. | |
| MeetingRequestId | String | False |
The MeetingRequestId of the Events table. | |
| CreatedBy | String | False |
The CreatedBy of the Events table. | |
| LastModifiedBy | String | False |
The LastModifiedBy of the Events table. | |
| VenuesAggregate | String | False |
The VenuesAggregate of the Events table. | |
| LanguagesAggregate | String | False |
The LanguagesAggregate of the Events table. | |
| PlannersAggregate | String | False |
The PlannersAggregate of the Events table. | |
| StakeholdersAggregate | String | False |
The StakeholdersAggregate of the Events table. | |
| CategoryId | String | False |
The CategoryId of the Events table. | |
| CategoryName | String | False |
The CategoryName of the Events table. | |
| CategoryCode | String | False |
The CategoryCode of the Events table. |
Returns data from the EventTransactions table.
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | False |
The Id of the EventTransactions table. | |
| EventId | String | False |
The EventId of the EventTransactions table. | |
| ProcessorTransactionId | String | False |
The ProcessorTransactionId of the EventTransactions table. | |
| JournalNumber | String | False |
The JournalNumber of the EventTransactions table. | |
| PaymentType | String | False |
The PaymentType of the EventTransactions table. | |
| PaymentMethod | String | False |
The PaymentMethod of the EventTransactions table. | |
| Success | Boolean | False |
The Success of the EventTransactions table. | |
| Date | Datetime | False |
The Date of the EventTransactions table. | |
| BatchNumber | String | False |
The BatchNumber of the EventTransactions table. | |
| ReferenceNumber | String | False |
The ReferenceNumber of the EventTransactions table. | |
| Amount | String | False |
The Amount of the EventTransactions table. | |
| Currency | String | False |
The Currency of the EventTransactions table. | |
| PaymentNote | String | False |
The PaymentNote of the EventTransactions table. | |
| Created | Datetime | False |
The Created of the EventTransactions table. | |
| CreatedBy | String | False |
The CreatedBy of the EventTransactions table. | |
| LastModified | Datetime | False |
The LastModified of the EventTransactions table. | |
| LastModifiedBy | String | False |
The LastModifiedBy of the EventTransactions table. | |
| EventId | String | False |
The EventId of the EventTransactions table. | |
| AttendeeId | String | False |
The AttendeeId of the EventTransactions table. |
Returns data from the Exhibitor table.
The Cvent API allows you to filter by certain fields when querying for data. The following fields can be filtered by the API:
All other filters are handled client-side.
The following is an example of a SELECT statement:
SELECT * FROM Exhibitors WHERE Id='cventId' OR Created <= '06/11/2020'
INSERT INTO Exhibitors (EventId, Name)
VALUES('DE830CBE-B4EB-4E2B-A51C-6F10384CD0AD', 'exhibitorName')
UPDATE Exhibitors SET name = 'UpdatedName', EventId='e0ce6b11-2c5c-48b2-8104-b71ace5eed13' WHERE EventId='DE830CBE-B4EB-4E2B-A51C-6F10384CD0AD' AND ID='462af84e-be35-4082-ac38-3cda475dd1de'
DELETE FROM Exhibitors where EventId='DE830CBE-B4EB-4E2B-A51C-6F10384CD0AD' and id = 'attendeeId'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | False |
The Id of the Exhibitor table. | |
| ProfileLogoId | String | False |
The ProfileLogoId of the BudgetTotals table. | |
| ProfileLogoUrl | String | False |
The ProfileLogoUrl of the Exhibitor table. | |
| BannerId | String | False |
The BannerId of the Exhibitor table. | |
| BannerUrl | String | False |
The BannerUrl of the Exhibitor table. | |
| Name | String | False |
The Name of the Exhibitor table. | |
| Description | String | False |
The Description of the Exhibitor table. | |
| Code | String | False |
The Code of the Exhibitor table. | |
| SourceId | String | False |
The SourceId of the Exhibitor table. | |
| Location | String | False |
The Location of the Exhibitor table. | |
| String | False |
The Email of the Exhibitor table. | ||
| MobilePhone | String | False |
The MobilePhone of the Exhibitor table. | |
| WorkPhone | String | False |
The WorkPhone of the Exhibitor table. | |
| OtherPhone | String | False |
The OtherPhone of the Exhibitor table. | |
| Website | String | False |
The Website of the Exhibitor table. | |
| Created | Datetime | False |
The Created of the Exhibitor table. | |
| CreatedBy | String | False |
The CreatedBy of the Exhibitor table. | |
| LastModified | Datetime | False |
The LastModified of the Exhibitor table. | |
| LastModifiedBy | String | False |
The LastModifiedBy of the Exhibitor table. | |
| Deleted | Boolean | False |
The Deleted of the Exhibitor table. | |
| EventSponsor | Boolean | False |
The EventSponsor of the Exhibitor table. | |
| Featured | Boolean | False |
The Featured of the Exhibitor table. | |
| EventId | String | False |
Events.Id |
The EventId of the Exhibitor table. |
| AddressAddress1 | String | False |
The AddressAddress1 of the Exhibitor table. | |
| AddressAddress2 | String | False |
The AddressAddress2 of the Exhibitor table. | |
| AddressCity | String | False |
The AddressCity of the Exhibitor table. | |
| AddressRegion | String | False |
The AddressRegion of the Exhibitor table. | |
| AddressPostalCode | String | False |
The AddressPostalCode of the Exhibitor table. | |
| AddressCountry | String | False |
The AddressCountry of the Exhibitor table. | |
| ContactLinksAggregate | String | False |
The ContactLinksAggregate of the Exhibitor table. | |
| SponsorshipLevelId | String | False |
The SponsorshipLevelAggregate of the Exhibitor table. |
Returns data from the Sessions table.
The Cvent API allows you to filter by certain fields when querying for data. The following fields can be filtered by the API:
All other filters are handled client-side.
The following is an example of a SELECT statement:
SELECT * from Sessions WHERE Created > '2024-02-16'
DELETE FROM Sessions WHERE Id ='2cbd2393-8b84-42e4-9702-dc32f67d02c6'
| Name | Type | ReadOnly | References | Description |
| IncludedSession | Boolean | False |
The IncludedSession of the Sessions table. | |
| Relevance | String | False |
The Relevance of the Sessions table. | |
| Id [KEY] | String | False |
The Id of the Sessions table. | |
| Virtual | Boolean | False |
The Virtual of the Sessions table. | |
| Title | String | False |
The Title of the Sessions table. | |
| Code | String | False |
The Code of the Sessions table. | |
| Description | String | False |
The Description of the Sessions table. | |
| Start | Datetime | False |
The Start of the Sessions table. | |
| End | Datetime | False |
The End of the Sessions table. | |
| Status | String | False |
The Status of the Sessions table. | |
| AutomaticallyOpensOn | String | False |
The AutomaticallyOpensOn of the Sessions table. | |
| AutomaticallyClosesOn | String | False |
The AutomaticallyClosesOn of the Sessions table. | |
| EnableWaitlist | Boolean | False |
The EnableWaitlist of the Sessions table. | |
| WaitlistCapacity | String | False |
The WaitlistCapacity of the Sessions table. | |
| EnableWaitlistVirtual | Boolean | False |
The EnableWaitlistVirtual of the Sessions table. | |
| Capacity | String | False |
The Capacity of the Sessions table. | |
| CapacityUnlimited | Boolean | False |
The CapacityUnlimited of the Sessions table. | |
| CapacityVirtual | String | False |
The CapacityVirtual of the Sessions table. | |
| VirtualCapacityUnlimited | Boolean | False |
The VirtualCapacityUnlimited of the Sessions table. | |
| WaitlistCapacityVirtual | String | False |
The WaitlistCapacityVirtual of the Sessions table. | |
| Timezone | String | False |
The Timezone of the Sessions table. | |
| DisplayOnAgenda | Boolean | False |
The DisplayOnAgenda of the Sessions table. | |
| Featured | Boolean | False |
The Featured of the Sessions table. | |
| OpenForRegistration | Boolean | False |
The OpenForRegistration of the Sessions table. | |
| OpenForAttendeeHub | Boolean | False |
The OpenForAttendeeHub of the Sessions table. | |
| PresentationType | String | False |
The PresentationType of the Sessions table. | |
| DataTagCode | String | False |
The DataTagCode of the Sessions table. | |
| Created | Datetime | False |
The Created of the Sessions table. | |
| CreatedBy | String | False |
The CreatedBy of the Sessions table. | |
| LastModified | Datetime | False |
The LastModified of the Sessions table. | |
| LastModifiedBy | String | False |
The LastModifiedBy of the Sessions table. | |
| EventId | String | False |
The EventId of the Sessions table. | |
| CategoryId | String | False |
The CategoryId of the Sessions table. | |
| CategoryName | String | False |
The CategoryName of the Sessions table. | |
| TypeId | String | False |
The TypeId of the Sessions table. | |
| TypeCode | String | False |
The TypeCode of the Sessions table. | |
| TypeName | String | False |
The TypeName of the Sessions table. | |
| LocationId | String | False |
The LocationId of the Sessions table. | |
| LocationCode | String | False |
The LocationCode of the Sessions table. | |
| LocationName | String | False |
The LocationName of the Sessions table. | |
| Group | String | False |
The GroupAggregate of the Sessions table. | |
| AdmissionItemsAggregate | String | False |
The AdmissionItemsAggregate of the Sessions table. | |
| RegistrationTypesAggregate | String | False |
The RegistrationTypesAggregate of the Sessions table. |
Returns data from the Speakers table.
The Cvent API allows you to filter by certain fields when querying for data. The following fields can be filtered by the API:
All other filters are handled client-side.
The following is an example of a SELECT statement:
SELECT * FROM Speakers WHERE FirstName='cvent'
INSERT INTO Speakers (FirstName, LastName, EventId) VALUES('Bob', 'Smith', 'e12ff613-966f-4fb9-bc91-8bd32c84f130')
UPDATE Speakers SET FirstName='Sam', LastName='Jackson', EventId='e12ff613-966f-4fb9-bc91-8bd32c84f130' WHERE Id='fc6d8759-2331-4ac7-8868-d9aed5b638c7'
DELETE FROM Speakers WHERE Id='fc6d8759-2331-4ac7-8868-d9aed5b638c7'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | False |
The Id of the Speakers table. | |
| Order | String | False |
The Order of the Speakers table. | |
| FirstName | String | False |
The FirstName of the Speakers table. | |
| LastName | String | False |
The LastName of the Speakers table. | |
| Code | String | False |
The Code of the Speakers table. | |
| String | False |
The Email of the Speakers table. | ||
| Prefix | String | False |
The Prefix of the Speakers table. | |
| Designation | String | False |
The Designation of the Speakers table. | |
| Company | String | False |
The Company of the Speakers table. | |
| Title | String | False |
The Title of the Speakers table. | |
| Visibility | Boolean | False |
The Visibility of the Speakers table. | |
| Biography | String | False |
The Biography of the Speakers table. | |
| InternalNote | String | False |
The InternalNote of the Speakers table. | |
| Featured | Boolean | False |
The Featured of the Speakers table. | |
| Created | Datetime | False |
The Created of the Speakers table. | |
| CreatedBy | String | False |
The CreatedBy of the Speakers table. | |
| LastModified | Datetime | False |
The LastModified of the Speakers table. | |
| LastModifiedBy | String | False |
The LastModifiedBy of the Speakers table. | |
| ContactId | String | False |
The ContactId of the Speakers table. | |
| EventId | String | False |
The EventId of the Speakers table. | |
| CategoryId | String | False |
The CategoryId of the Speakers table. | |
| CategoryName | String | False |
The CategoryName of the Speakers table. |
Returns data from the Users table.
The Cvent API allows you to filter by certain fields when querying for data. The following fields can be filtered by the API:
All other filters are handled client-side.
The following is an example of a SELECT statement:
SELECT * FROM Users WHERE UserName = '[email protected]'
INSERT INTO Users (UserName, Active, UserType, GivenName, FamilyName, Timezone, Locale, EmailValue, GroupValue, SendLoginDetails)
VALUES ('[email protected]', 'true', 'Planner Account User','Test','Test','America/New_York', 'en-US', '[email protected]', '1234b4e4-abcd-4a6d-adb7-ce81bbc4e019', true)
UPDATE Users SET UserName='[email protected]', Active=true, UserType='Planner Account User', GivenName='Bob', FamilyName='Test', MiddleName='', Timezone='America/New_York', Locale='en-US', EmailValue='[email protected]', GroupValue='3290b4e4-afce-4a6d-adb7-ce81bbc4e019', SendLoginDetails=true WHERE Id='efbf1234-ce7c-4e6a-951f-8f832365c0d1'
DELETE FROM Users WHERE Id='efbf1234-ce7c-4e6a-951f-8f832365c0d1'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | False |
The Id of the Users table. | |
| UserName | String | False |
The UserName of the Users table. | |
| Active | Boolean | False |
The Active of the Users table. | |
| Title | String | False |
The Title of the Users table. | |
| UserType | String | False |
The UserType of the Users table. | |
| Timezone | String | False |
The Timezone of the Users table. | |
| Locale | String | False |
The Locale of the Users table. | |
| GivenName | String | False |
The GivenName of the Users table. | |
| FamilyName | String | False |
The FamilyName of the Users table. | |
| MiddleName | String | False |
The MiddleName of the Users table. | |
| HonorificPrefix | String | False |
The HonorificPrefix of the Users table. | |
| EmailType | String | False |
The EmailType of the Users table. | |
| EmailValue | String | False |
The EmailValue of the Users table. | |
| EmailPrimary | Boolean | False |
The EmailPrimary of the Users table. | |
| GroupValue | String | False |
The GroupValue of the Users table. | |
| GroupDisplay | String | False |
The GroupDisplay of the Users table. | |
| SendLoginDetails | Boolean | False |
The SendLoginDetails of the Users table. | |
| Created | Datetime | False |
Datetime when the record was created. | |
| LastModified | Datetime | False |
Datetime when the record was last updated. |
Views are similar to tables in the way that data is represented; however, views are read-only.
Queries can be executed against a view as if it were a normal table.
| Name | Description |
| Appointments | Returns data from the Appointments table. |
| BudgetTotals | Returns data from a BudgetTotals table. |
| ContactTypes | Returns data from the ContactTypes table. |
| Emails | Returns data from the Emails table. |
| EventOrderItems | Returns data from the EventOrderItems table. |
| EventOrders | Returns data from the EventOrders table. |
| EventQuestions | Returns data from the EventQuestions table. |
| EventSurveyResponses | Returns data from the EventSurveyResponses table. |
| SessionDocuments | Returns data from the SessionDocuments table. |
| StandaloneSurveys | Returns data from event and standalone surveys associated to an account. |
| Surveys | Returns data from the surveys associated to a single event. |
Returns data from the Appointments table.
| Name | Type | References | Description |
| Id [KEY] | String | The Id of the Appointments table. | |
| AutoAcceptAttendees | String | The AutoAcceptAttendees of the Attendess table. | |
| EnforceScheduleRules | String | The EnforceScheduleRules of the Attendess table. | |
| Modified | String | The Modified of the Attendess table. | |
| Deleted | String | The Deleted of the Attendess table. | |
| Code | String | The Code of the Attendess table. | |
| Name | String | The Name of the Attendess table. | |
| Description | String | The Description of the Attendess table. | |
| Start | String | The Start of the Attendess table. | |
| End | String | The End of the Attendess table. | |
| Status | String | The Status of the Attendess table. | |
| Created | String | The Created of the Attendess table. | |
| CreatedBy | String | The CreatedBy of the Attendess table. | |
| LastModified | String | The LastModified of the Attendess table. | |
| LastModifiedBy | String | The LastModifiedBy of the Attendess table. | |
| AppointmentEventId | String | The AppointmentEventId of the Attendess table. | |
| LocationName | String | The LocationName of the Attendess table. | |
| TypeName | String | The TypeName of the Attendess table. | |
| ParticipantsAggregate | String | The ParticipantsAggregate of the Attendess table. | |
| QuestionsAggregate | String | The QuestionsAggregate of the Attendess table. |
Returns data from a BudgetTotals table.
The Cvent API allows you to filter by certain fields when querying for data. The following fields can be filtered by the API:
All other filters are handled client-side.
The following is an example of a SELECT statement:
SELECT * FROM BudgetTotals WHERE EventId='fee38876-e5c1-421f-a613-63f812501620'
| Name | Type | References | Description |
| EventId [KEY] | String |
Events.Id | The EventId of the BudgetTotals table. |
| LastModifiedDate | Datetime | The LastModifiedDate of the BudgetTotals table. | |
| Currency | String | The Currency of the BudgetTotals table. | |
| VersionId | String | The VersionId of the BudgetTotals table. | |
| VersionName | String | The VersionName of the BudgetTotals table. | |
| VersionDefault | String | The VersionDefault of the BudgetTotals table. | |
| TotalHighLevelEstimateAmount | Double | The TotalHighLevelEstimateAmount of the BudgetTotals table. | |
| CostDetailAggregate | String | The CostDetailAggregate of the BudgetTotals table. |
Returns data from the ContactTypes table.
| Name | Type | References | Description |
| Id [KEY] | String | The Id of the ContactTypes table. | |
| Code | String | The Code of the ContactTypes table. | |
| Name | String | The Name of the ContactTypes table. | |
| Description | String | The Description of the ContactTypes table. |
Returns data from the Emails table.
| Name | Type | References | Description |
| Id [KEY] | String | The Id of the Emails table. | |
| Subject | String | The Subject of the Emails table. | |
| From | String | The From of the Emails table. | |
| To | String | The To of the Emails table. | |
| Type | String | The Type of the Emails table. | |
| Sent | Datetime | The Sent of the Emails table. | |
| Status | String | The Status of the Emails table. | |
| Undeliverable | Boolean | The Undeliverable of the Emails table. | |
| Opened | Boolean | The Opened of the Emails table. | |
| FirstOpened | String | The FirstOpened of the Emails table. | |
| Clicked | Boolean | The Clicked of the Emails table. | |
| FirstClicked | String | The FirstClicked of the Emails table. | |
| Bounced | Boolean | The Bounced of the Emails table. | |
| Created | Datetime | The Created of the Emails table. | |
| CreatedBy | String | The CreatedBy of the Emails table. | |
| LastModified | Datetime | The LastModified of the Emails table. | |
| LastModifiedBy | String | The LastModifiedBy of the Emails table. | |
| EventId | String | The EventId of the Emails table. | |
| ContactId | String | The ContactId of the Emails table. | |
| AttendeeId | String | The AttendeeId of the Emails table. |
Returns data from the EventOrderItems table.
| Name | Type | References | Description |
| Id | String | The Id of the EventOrderItems table. | |
| EventId | String |
Events.Id | The EventId field of the EventOrderItems table. |
| Guest | Boolean | The Guest field of the EventOrderItems table. | |
| Active | Boolean | The Active field of the EventOrderItems table. | |
| Name | String | The Name field of the EventOrderItems table. | |
| Price | Double | The Price field of the EventOrderItems table. | |
| Quantity | Double | The Quantity field of the EventOrderItems table. | |
| AmountOrdered | Double | The AmountOrdered field of the EventOrderItems table. | |
| AmountPaid | Double | The AmountPaid field of the EventOrderItems table. | |
| AmountDue | Double | The AmountDue field of the EventOrderItems table. | |
| ProductPriceTierAmount | Double | The ProductPriceTierAmount field of the EventOrderItems table. | |
| Tiered | Boolean | The Tiered field of the EventOrderItems table. | |
| Deleted | Boolean | The Deleted field of the EventOrderItems table. | |
| Created | Datetime | The Created field of the EventOrderItems table. | |
| CreatedBy | String | The CreatedBy field of the EventOrderItems table. | |
| LastModified | Datetime | The LastModified field of the EventOrderItems table. | |
| LastModifiedBy | String | The LastModifiedBy field of the EventOrderItems table. | |
| ProductId | String | The ProductId field of the EventOrderItems table. | |
| ProductType | String | The ProductType field of the EventOrderItems table. | |
| OrderId | String | The OrderId field of the EventOrderItems table. | |
| OrderType | String | The OrderType field of the EventOrderItems table. | |
| AttendeeId | String | The AttendeeId field of the EventOrderItems table. | |
| GuestDetailId | String | The GuestDetailId field of the EventOrderItems table. | |
| FeeId | String | The FeeId field of the EventOrderItems table. | |
| FeeName | String | The FeeName field of the EventOrderItems table. | |
| GeneralLedgerItemsId | String | The GeneralLedgerItemsId field of the EventOrderItems table. | |
| GeneralLedgerItemsName | String | The GeneralLedgerItemsName field of the EventOrderItems table. | |
| GeneralLedgerItemsCode | String | The GeneralLedgerItemsCode field of the EventOrderItems table. | |
| GeneralLedgerItemsDescription | String | The GeneralLedgerItemsDescription field of the EventOrderItems table. | |
| GeneralLedgerItemsAllocationPercentage | String | The GeneralLedgerItemsAllocationPercentage field of the EventOrderItems table. | |
| DiscountsId | String | The GeneralLedgerItemsDescription field of the EventOrderItems table. | |
| DiscountsName | String | The GeneralLedgerItemsDescription field of the EventOrderItems table. | |
| DiscountsCode | String | The GeneralLedgerItemsDescription field of the EventOrderItems table. | |
| DiscountsType | String | The GeneralLedgerItemsDescription field of the EventOrderItems table. | |
| DiscountsValue | String | The GeneralLedgerItemsDescription field of the EventOrderItems table. | |
| DiscountsAmount | String | The GeneralLedgerItemsDescription field of the EventOrderItems table. |
Returns data from the EventOrders table.
| Name | Type | References | Description |
| Id | String | The Id of the EventOrders table. | |
| EventId | String | The LastModifiedBy of the EventOrders table. | |
| AttendeeId | String | The VenuesAggregate of the EventOrders table. | |
| Number | String | The LanguagesAggregate of the EventOrders table. | |
| Cancelled | Boolean | The PlannersAggregate of the EventOrders table. | |
| Type | String | The StakeholdersAggregate of the EventOrders table. | |
| InvoiceNumber | String | The StakeholdersAggregate of the EventOrders table. | |
| AmountOrdered | Decimal | The StakeholdersAggregate of the EventOrders table. | |
| AmountPaid | Decimal | The StakeholdersAggregate of the EventOrders table. | |
| AmountDue | Decimal | The StakeholdersAggregate of the EventOrders table. | |
| DiscountName | String | The StakeholdersAggregate of the EventOrders table. | |
| DiscountCode | String | The StakeholdersAggregate of the EventOrders table. | |
| DiscountType | String | The StakeholdersAggregate of the EventOrders table. | |
| DiscountValue | String | The StakeholdersAggregate of the EventOrders table. | |
| PaymentMethod | String | The StakeholdersAggregate of the EventOrders table. | |
| ReferenceNumber | String | The StakeholdersAggregate of the EventOrders table. | |
| Created | Datetime | The StakeholdersAggregate of the EventOrders table. | |
| CreatedBy | String | The StakeholdersAggregate of the EventOrders table. | |
| LastModified | Datetime | The StakeholdersAggregate of the EventOrders table. | |
| LastModifiedBy | String | The StakeholdersAggregate of the EventOrders table. |
Returns data from the EventQuestions table.
| Name | Type | References | Description |
| Id [KEY] | String | The Id of the EventQuestions table. | |
| Text | String | The Text of the EventQuestions table. | |
| Code | String | The Code of the EventQuestions table. | |
| Tag | String | The Tag of the EventQuestions table. | |
| Created | Datetime | The Created of the EventQuestions table. | |
| CreatedBy | String | The CreatedBy of the EventQuestions table. | |
| LastModified | Datetime | The LastModified of the EventQuestions table. | |
| LastModifiedBy | String | The LastModifiedBy of the EventQuestions table. | |
| EventId | String | The EventId of the EventQuestions table. |
Returns data from the EventSurveyResponses table.
| Name | Type | References | Description |
| Id [KEY] | String | The Id of the EventSurveyResponses table. | |
| Score | String | The Score of the EventSurveyResponses table. | |
| Created | Datetime | The Created of the EventSurveyResponses table. | |
| CreatedBy | String | The CreatedBy of the EventSurveyResponses table. | |
| LastModified | Datetime | The LastModified of the EventSurveyResponses table. | |
| LastModifiedBy | String | The LastModifiedBy of the EventSurveyResponses table. | |
| EventId | String | The EventId of the EventSurveyResponses table. | |
| SurveyId | String | The SurveyId of the EventSurveyResponses table. | |
| SessionId | String | The SessionId of the EventSurveyResponses table. | |
| SpeakerId | String | The SpeakerId of the EventSurveyResponses table. | |
| RespondentId | String | The RespondentId of the EventSurveyResponses table. | |
| QuestionId | String | The QuestionId of the EventSurveyResponses table. | |
| AnswersAggregate | String | The AnswersAggregate of the EventSurveyResponses table. |
Returns data from the SessionDocuments table.
| Name | Type | References | Description |
| Href | String | The Href of the SessionDocuments table. | |
| SessionId [KEY] | String |
Sessions.Id | The SessionId of the SessionDocuments table. |
| FriendlyName | String | The FriendlyName of the SessionDocuments table. | |
| Type | String | The Type of the SessionDocuments table. | |
| Size | String | The Size of the SessionDocuments table. | |
| DisplayEnabled | Boolean | The DisplayEnabled of the SessionDocuments table. | |
| FileId | String | The FileId of the SessionDocuments table. |
Returns data from event and standalone surveys associated to an account.
| Name | Type | References | Description |
| Id [KEY] | String | The Id of the Surveys table. | |
| EventId | String | The EventId of the StandaloneSurveys table. | |
| ResponseCount | String | The responseCount of the Surveys table. | |
| Status | String | The Status of the Surveys table. | |
| Type | String | The type of the Surveys table. | |
| ActivateDate | String | The AudienceType of the Surveys table. | |
| Title | String | The title of the Surveys table. | |
| Code | String | The code of the Surveys table. | |
| Timezone | String | The Timezone of the Surveys table. | |
| Description | String | The Description of the Surveys table. | |
| CloseAfter | String | The CloseAfter of the Surveys table. | |
| Created | Datetime | The Created of the Surveys table. | |
| CreatedBy | String | The CreatedBy of the Surveys table. | |
| LastModified | Datetime | The LastModified of the Surveys table. | |
| LastModifiedBy | String | The LastModifiedBy of the Surveys table. | |
| AuthorFirstName | String | The AuthorFirstName of the Surveys table. | |
| AuthorLastName | String | The AuthorLastName of the Surveys table. | |
| AuthorCompany | String | The AuthorCompany of the Surveys table. | |
| AuthorTitle | String | The AuthorTitle of the Surveys table. | |
| AuthorEmail | String | The AuthorEmail of the Surveys table. |
Returns data from the surveys associated to a single event.
| Name | Type | References | Description |
| Id [KEY] | String | The Id of the Surveys table. | |
| EventId [KEY] | String |
Events.Id | The EventId of the Surveys table. |
| Type | String | The Type of the Surveys table. | |
| AvailableTo | String | The AvailableTo of the Surveys table. | |
| AudienceType | String | The AudienceType of the Surveys table. | |
| SessionMatch | String | The SessionMatch of the Surveys table. | |
| ParentId | String | The ParentId of the Surveys table. | |
| Title | String | The Title of the Surveys table. | |
| Code | String | The Code of the Surveys table. | |
| Timezone | String | The Timezone of the Surveys table. | |
| Description | String | The Description of the Surveys table. | |
| CloseAfter | String | The CloseAfter of the Surveys table. | |
| Created | Datetime | The Created of the Surveys table. | |
| CreatedBy | String | The CreatedBy of the Surveys table. | |
| LastModified | Datetime | The LastModified of the Surveys table. | |
| LastModifiedBy | String | The LastModifiedBy of the Surveys table. | |
| SessionsAggregate | String | The SessionsAggregate of the Surveys table. | |
| AuthorFirstName | String | The AuthorFirstName of the Surveys table. | |
| AuthorLastName | String | The AuthorLastName of the Surveys table. | |
| AuthorCompany | String | The AuthorCompany of the Surveys table. | |
| AuthorTitle | String | The AuthorTitle of the Surveys table. | |
| AuthorEmail | String | The AuthorEmail of the Surveys table. |
Stored procedures are function-like interfaces that extend the functionality of the Sync App beyond simple SELECT/INSERT/UPDATE/DELETE operations with Cvent.
Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Cvent, along with an indication of whether the procedure succeeded or failed.
| Name | Description |
| AssignContactProfilePicture | Uploads a file and returns a unique ID to identify the file. The file must be less than 10MB. |
Uploads a file and returns a unique ID to identify the file. The file must be less than 10MB.
| Name | Type | Required | Description |
| ContactId | String | False | Full local file path, including the file name, for the file being uploaded. This field is mandatory if FileData is not provided. |
| FileId | String | False | Base-64 encoded string containing the entire contents of the file. Use this field when LocalFile is not provided. |
| Name | Type | Description |
| Success | String | Indicates whether the file upload operation completed successfully. Returns true for success and false for failure. |
Gets an authentication token from Cvent.
| Name | Type | Required | Description |
| AuthMode | String | False | The type of authentication mode to use. Select App for getting authentication tokens via a desktop app. Select Web for getting authentication tokens via a Web app.
The allowed values are APP, WEB. The default value is APP. |
| Scope | String | False | A comma-separated list of permissions to request from the user. Please check the Cvent API for a list of available permissions. |
| CallbackUrl | String | False | The URL the user will be redirected to after authorizing your application. This value must match the Redirect URL you have specified in the Cvent app settings. Only needed when the Authmode parameter is Web. |
| Verifier | String | False | The verifier returned from Cvent after the user has authorized your app to have access to their data. This value will be returned as a parameter to the callback URL. |
| State | String | False | Indicates any state which may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to the Cvent authorization server and back. Uses include redirecting the user to the correct resource in your site, nonces, and cross-site-request-forgery mitigations. |
| Name | Type | Description |
| OAuthAccessToken | String | The access token used for communication with Cvent. |
| OAuthRefreshToken | String | The OAuth refresh token. This is the same as the access token in the case of Cvent. |
| ExpiresIn | String | The remaining lifetime on the access token. A -1 denotes that it will not expire. |
Uploads a file and returns a unique ID to identify the file. The file must be less than 10MB.
| Name | Type | Required | Description |
| LocalFile | String | False | Full local file path, including the file name, for the file being uploaded. This field is mandatory if FileData is not provided. |
| FileData | String | False | Base-64 encoded string containing the entire contents of the file. Use this field when LocalFile is not provided. |
| FileName | String | False | Desired name for the uploaded file in CVent. If left blank, the name from LocalFile will be used. Required when FileData is provided. |
| Name | Type | Description |
| Success | String | Indicates whether the file upload operation completed successfully. Returns true for success and false for failure. |
| Id | String | Unique internal identifier assigned to the uploaded file |
The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.
For more information on establishing a connection, see Establishing a Connection.
| Property | Description |
| OAuthClientId | Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication. |
| OAuthClientSecret | Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.). |
| Scope | Specifies the scope of the authenticating user's access to the application, to ensure they get appropriate access to data. If a custom OAuth application is needed, this is generally specified at the time the application is created. |
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
| Property | Description |
| FirewallType | Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall. |
| FirewallServer | Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources. |
| FirewallPort | Specifies the TCP port to be used for a proxy-based firewall. |
| FirewallUser | Identifies the user ID of the account authenticating to a proxy-based firewall. |
| FirewallPassword | Specifies the password of the user account authenticating to a proxy-based firewall. |
| Property | Description |
| ProxyAutoDetect | Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server. |
| ProxyServer | Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic. |
| ProxyPort | Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client. |
| ProxyAuthScheme | Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
| ProxyUser | Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property. |
| ProxyPassword | Specifies the password of the user specified in the ProxyUser connection property. |
| ProxySSLType | Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property. |
| ProxyExceptions | Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property. |
| Property | Description |
| LogModules | Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged. |
| Property | Description |
| Location | Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path. |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Tables | Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC . |
| Views | Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC . |
| Property | Description |
| MaxRows | Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY. |
| Other | Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. |
| UserDefinedViews | Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file. |
This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.
| Property | Description |
| OAuthClientId | Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication. |
| OAuthClientSecret | Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.). |
| Scope | Specifies the scope of the authenticating user's access to the application, to ensure they get appropriate access to data. If a custom OAuth application is needed, this is generally specified at the time the application is created. |
Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
This property is required in two cases:
(When the driver provides embedded OAuth credentials, this value may already be provided by the Sync App and thus not require manual entry.)
OAuthClientId is generally used alongside other OAuth-related properties such as OAuthClientSecret and OAuthSettingsLocation when configuring an authenticated connection.
OAuthClientId is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can usually find this value in your identity provider’s application registration settings. Look for a field labeled Client ID, Application ID, or Consumer Key.
While the client ID is not considered a confidential value like a client secret, it is still part of your application's identity and should be handled carefully. Avoid exposing it in public repositories or shared configuration files.
For more information on how this property is used when configuring a connection, see Establishing a Connection.
Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
This property (sometimes called the application secret or consumer secret) is required when using a custom OAuth application in any flow that requires secure client authentication, such as web-based OAuth, service-based connections, or certificate-based authorization flows. It is not required when using an embedded OAuth application.
The client secret is used during the token exchange step of the OAuth flow, when the driver requests an access token from the authorization server. If this value is missing or incorrect, authentication fails with either an invalid_client or an unauthorized_client error.
OAuthClientSecret is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can obtain this value from your identity provider when registering the OAuth application.
Notes:
For more information on how this property is used when configuring a connection, see Establishing a Connection
Specifies the scope of the authenticating user's access to the application, to ensure they get appropriate access to data. If a custom OAuth application is needed, this is generally specified at the time the application is created.
Scopes are set to define what kind of access the authenticating user will have; for example, read, read and write, restricted access to sensitive information. System administrators can use scopes to selectively enable access by functionality or security clearance.
When InitiateOAuth is set to GETANDREFRESH, you must use this property if you want to change which scopes are requested.
When InitiateOAuth is set to either REFRESH or OFF, you can change which scopes are requested using either this property or the Scope input.
This section provides a complete list of the SSL properties you can configure in the connection string for this provider.
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
Specifies the certificate to be accepted from the server when connecting using TLS/SSL.
If you are using a TLS/SSL connection, use this property to specify the TLS/SSL certificate to be accepted from the server. If you specify a value for this property, all other certificates that are not trusted by the machine are rejected.
This property can take the following forms:
| Description | Example |
| A full PEM Certificate (example shortened for brevity) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
| A path to a local file containing the certificate | C:\cert.cer |
| The public key (example shortened for brevity) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
| The MD5 Thumbprint (hex values can also be either space- or colon-separated) | ecadbdda5a1529c58a1e9e09828d70e4 |
| The SHA1 Thumbprint (hex values can also be either space- or colon-separated) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
Note: It is possible to use '*' to signify that all certificates should be accepted, but due to security concerns this is not recommended.
This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.
| Property | Description |
| FirewallType | Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall. |
| FirewallServer | Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources. |
| FirewallPort | Specifies the TCP port to be used for a proxy-based firewall. |
| FirewallUser | Identifies the user ID of the account authenticating to a proxy-based firewall. |
| FirewallPassword | Specifies the password of the user account authenticating to a proxy-based firewall. |
Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Note: By default, the Sync App connects to the system proxy. To disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.
The following table provides port number information for each of the supported protocols.
| Protocol | Default Port | Description |
| TUNNEL | 80 | The port where the Sync App opens a connection to Cvent. Traffic flows back and forth via the proxy at this location. |
| SOCKS4 | 1080 | The port where the Sync App opens a connection to Cvent. SOCKS 4 then passes theFirewallUser value to the proxy, which determines whether the connection request should be granted. |
| SOCKS5 | 1080 | The port where the Sync App sends data to Cvent. If the SOCKS 5 proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes. |
To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.
Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Specifies the TCP port to be used for a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Identifies the user ID of the account authenticating to a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Specifies the password of the user account authenticating to a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.
| Property | Description |
| ProxyAutoDetect | Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server. |
| ProxyServer | Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic. |
| ProxyPort | Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client. |
| ProxyAuthScheme | Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
| ProxyUser | Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property. |
| ProxyPassword | Specifies the password of the user specified in the ProxyUser connection property. |
| ProxySSLType | Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property. |
| ProxyExceptions | Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property. |
Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
When this connection property is set to True, the Sync App checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details).
This connection property takes precedence over other proxy settings. If you want to configure the Sync App to connect to a specific proxy server, set ProxyAutoDetect to False.
To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.
Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic.
The Sync App only routes HTTP traffic through the proxy server specified in this connection property when ProxyAutoDetect is set to False.
If ProxyAutoDetect is set to True (the default), the Sync App instead routes HTTP traffic through the proxy server specified in your system proxy settings.
Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client.
The Sync App only routes HTTP traffic through the ProxyServer port specified in this connection property when ProxyAutoDetect is set to False.
If ProxyAutoDetect is set to True (the default), the Sync App instead routes HTTP traffic through the proxy server port specified in your system proxy settings.
For other proxy types, see FirewallType.
Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
Supported authentication types :
For all values other than NONE, you must also set the ProxyUser and ProxyPassword connection properties.
If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.
Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property.
The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.
After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:
| ProxyAuthScheme Value | Value to set for ProxyUser |
| BASIC | The username of a user registered with the proxy server. |
| DIGEST | The username of a user registered with the proxy server. |
| NEGOTIATE | The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user. |
| NTLM | The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user. |
| NONE | Do not set the ProxyPassword connection property. |
Note: The Sync App only uses this username if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True (the default), the Sync App instead uses the username specified in your system proxy settings.
Specifies the password of the user specified in the ProxyUser connection property.
The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.
After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:
| ProxyAuthScheme Value | Value to set for ProxyPassword |
| BASIC | The password associated with the proxy server user specified in ProxyUser. |
| DIGEST | The password associated with the proxy server user specified in ProxyUser. |
| NEGOTIATE | The password associated with the Windows user account specified in ProxyUser. |
| NTLM | The password associated with the Windows user account specified in ProxyUser. |
| NONE | Do not set the ProxyPassword connection property. |
For SOCKS 5 authentication or tunneling, see FirewallType.
Note: The Sync App only uses this password if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True (the default), the Sync App instead uses the password specified in your system proxy settings.
Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
This property determines when to use SSL for the connection to the HTTP proxy specified by ProxyServer. You can set this connection property to the following values :
| AUTO | Default setting. If ProxyServer is set to an HTTPS URL, the Sync App uses the TUNNEL option. If ProxyServer is set to an HTTP URL, the component uses the NEVER option. |
| ALWAYS | The connection is always SSL enabled. |
| NEVER | The connection is not SSL enabled. |
| TUNNEL | The connection is made through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy. |
Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.
The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.
Note: The Sync App uses the system proxy settings by default, without further configuration needed. If you want to explicitly configure proxy exceptions for this connection, set ProxyAutoDetect to False.
This section provides a complete list of the Logging properties you can configure in the connection string for this provider.
| Property | Description |
| LogModules | Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged. |
Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.
The Sync App writes details about each operation it performs into the logfile specified by the Logfile connection property.
Each of these logged operations are assigned to a themed category called a module, and each module has a corresponding short code used to labels individual Sync App operations as belonging to that module.
When this connection property is set to a semicolon-separated list of module codes, only operations belonging to the specified modules are written to the logfile. Note that this only affects which operations are logged moving forward and doesn't retroactively alter the existing contents of the logfile. For example: INFO;EXEC;SSL;META;
By default, logged operations from all modules are included.
You can explicitly exclude a module by prefixing it with a "-". For example: -HTTP
To apply filters to submodules, identify them with the syntax <module name>.<submodule name>. For example, the following value causes the Sync App to only log actions belonging to the HTTP module, and further refines it to exclude actions belonging to the Res submodule of the HTTP module: HTTP;-HTTP.Res
Note that the logfile filtering triggered by the Verbosity connection property takes precedence over the filtering imposed by this connection property. This means that operations of a higher verbosity level than the level specified in the Verbosity connection property are not printed in the logfile, even if they belong to one of the modules specified in this connection property.
The available modules and submodules are:
| Module Name | Module Description | Submodules |
| INFO | General Information. Includes the connection string, product version (build number), and initial connection messages. |
|
| EXEC | Query Execution. Includes execution messages for user-written SQL queries, parsed SQL queries, and normalized SQL queries. Success/failure messages for queries and query pages appear here as well. |
|
| HTTP | HTTP protocol messages. Includes HTTP requests/responses (including POST messages), as well as Kerberos related messages. |
|
| WSDL | Messages pertaining to the generation of WSDL/XSD files. | — |
| SSL | SSL certificate messages. |
|
| AUTH | Authentication related failure/success messages. |
|
| SQL | Includes SQL transactions, SQL bulk transfer messages, and SQL result set messages. |
|
| META | Metadata cache and schema messages. |
|
| FUNC | Information related to executing SQL functions. |
|
| TCP | Incoming and outgoing raw bytes on TCP transport layer messages. |
|
| FTP | Messages pertaining to the File Transfer Protocol. |
|
| SFTP | Messages pertaining to the Secure File Transfer Protocol. |
|
| POP | Messages pertaining to data transferred via the Post Office Protocol. |
|
| SMTP | Messages pertaining to data transferred via the Simple Mail Transfer Protocol. |
|
| CORE | Messages relating to various internal product operations not covered by other modules. | — |
| DEMN | Messages related to SQL remoting. | — |
| CLJB | Messages about bulk data uploads (cloud job). |
|
| SRCE | Miscellaneous messages produced by the product that don't belong in any other module. | — |
| TRANCE | Advanced messages concerning low-level product operations. | — |
This section provides a complete list of the Schema properties you can configure in the connection string for this provider.
| Property | Description |
| Location | Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path. |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Tables | Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC . |
| Views | Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC . |
Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
The Location property is only needed if you want to either customize definitions (for example, change a column name, ignore a column, etc.) or extend the data model with new tables, views, or stored procedures.
If left unspecified, the default location is %APPDATA%\\CData\\Cvent Data Provider\\Schema, where %APPDATA% is set to the user's configuration directory:
| Platform | %APPDATA% |
| Windows | The value of the APPDATA environment variable |
| Linux | ~/.config |
Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.
Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
Listing all available tables from some databases can take extra time, thus degrading performance. Providing a list of tables in the connection string saves time and improves performance.
If there are lots of tables available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those tables. To do this, specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.
Note: If you are connecting to a data source with multiple schemas or catalogs, you must specify each table you want to view by its fully qualified name. This avoids ambiguity between tables that may exist in multiple catalogs or schemas.
Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .
Listing all available views from some databases can take extra time, thus degrading performance. Providing a list of views in the connection string saves time and improves performance.
If there are lots of views available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those views. To do this, specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.
Note: If you are connecting to a data source with multiple schemas or catalogs, you must specify each view you want to examine by its fully qualified name. This avoids ambiguity between views that may exist in multiple catalogs or schemas.
This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.
| Property | Description |
| MaxRows | Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY. |
| Other | Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. |
| UserDefinedViews | Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file. |
Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
The default value for this property, -1, means that no row limit is enforced unless the query explicitly includes a LIMIT clause. (When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting.)
Setting MaxRows to a whole number greater than 0 ensures that queries do not return excessively large result sets by default.
This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.
Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.
This property allows advanced users to configure hidden properties for specialized situations, with the advice of our Support team. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. To define multiple properties, use a semicolon-separated list.
Note: It is strongly recommended to set these properties only when advised by the Support team to address specific scenarios or issues.
| Property | Description |
| DefaultColumnSize | Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000. |
| ConvertDateTimeToGMT=True | Converts date-time values to GMT, instead of the local time of the machine. The default value is False (use local time). |
| RecordToFile=filename | Records the underlying socket data transfer to the specified file. |
Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
This property allows you to define which pseudocolumns the Sync App exposes as table columns.
To specify individual pseudocolumns, use the following format:
Table1=Column1;Table1=Column2;Table2=Column3
To include all pseudocolumns for all tables use:
*=*
Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.
Timeout is set to 60 seconds by default. To disable timeouts, set this property to 0.
Disabling the timeout allows operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server.
Note: Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.
Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.
UserDefinedViews allows you to define and manage custom views through a JSON-formatted configuration file called UserDefinedViews.json. These views are automatically recognized by the Sync App and enable you to execute custom SQL queries as if they were standard database views. The JSON file defines each view as a root element with a child element called "query", which contains the SQL query for the view.
For example:
{
"MyView": {
"query": "SELECT * FROM Events WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
You can use this property to define multiple views in a single file and specify the filepath.
For example:
UserDefinedViews=C:\Path\To\UserDefinedViews.jsonWhen you specify a view in UserDefinedViews, the Sync App only sees that view.
For further information, see User Defined Views.
LZMA from 7Zip LZMA SDK
LZMA SDK is placed in the public domain.
Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.
LZMA2 from XZ SDK
Version 1.9 and older are in the public domain.
Xamarin.Forms
Xamarin SDK
The MIT License (MIT)
Copyright (c) .NET Foundation Contributors
All rights reserved.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
NSIS 3.10
Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
1. DEFINITIONS
"Contribution" means:
a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:
i) changes to the Program, and
ii) additions to the Program;
where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.
"Contributor" means any person or entity that distributes the Program.
"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.
"Program" means the Contributions distributed in accordance with this Agreement.
"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.
2. GRANT OF RIGHTS
a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.
b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.
c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.
d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.
3. REQUIREMENTS
A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:
a) it complies with the terms and conditions of this Agreement; and
b) its license agreement:
i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;
ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;
iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and
iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.
When the Program is made available in source code form:
a) it must be made available under this Agreement; and
b) a copy of this Agreement must be included with each copy of the Program.
Contributors may not remove or alter any copyright notices contained within the Program.
Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.
4. COMMERCIAL DISTRIBUTION
Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.
For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.
5. NO WARRANTY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.
6. DISCLAIMER OF LIABILITY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
7. GENERAL
If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.
If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.
All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.
Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.
This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.