JDBC Driver for Cvent

Build 24.0.9029

Establishing a Connection

Creating a JDBC Data Source

You can create a JDBC data source to connect from your Java application. Creating a JDBC data source based on the CData JDBC Driver for Cvent consists of three basic steps:

  • Add the driver JAR file to the classpath. The JAR file is located in the lib subfolder of the installation directory. Note that the .lic file must be located in the same folder as the JAR file.
  • Provide the driver class. For example:
    cdata.jdbc.cvent.CventDriver
  • Provide the JDBC URL. For example:
    jdbc:cvent:InitiateOAuth=GETANDREFRESH;OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;
    
    or
    
    jdbc:cdata:cvent:InitiateOAuth=GETANDREFRESH;OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;

    The second format above can be used whenever there is a conflict in your application between drivers using the same URL format to ensure you are using the CData driver. The URL must start with either "jdbc:cvent:" or "jdbc:cdata:cvent:" and can include any of the connection properties in name-value pairs separated with semicolons.

The Cvent REST API uses the client credentials flow of OAuth 2.0 to authorize requests to the Cvent.

Before You Connect

Before you can authenticate to Cvent, you must create a workspace and an OAuth application.

Creating a Workspace

To create a workspace:

  1. Sign into Cvent and navigate to App Switcher (the blue button in the upper right corner of the page) > Admin.
  2. In the Admin menu, navigate to Integrations > REST API.
  3. A new tab launches for Developer Management. Click on Manage API Access in the new tab.
  4. Create a Workspace and name it. Select the scopes you would like your developers to have access to. Scopes control what data domains the developer can access.
    • Choose All to allow developers to choose any scope, and any future scopes added to the REST API.
    • Choose Custom to limit the scopes developers can choose for their OAuth apps to selected scopes. To access all tables exposed by the driver, you need to set the following scopes:
      • event/attendees:read
      • event/attendees:write
      • event/contacts:read
      • event/contacts:write
      • event/custom-fields:read
      • event/custom-fields:write
      • event/events:read
      • event/events:write
      • event/sessions:delete
      • event/sessions:read
      • event/sessions:write
      • event/speakers:delete
      • event/speakers:read
      • event/speakers:write
      • budget/budget-items:read
      • budget/budget-items:write
      • exhibitor/exhibitors:read
      • exhibitor/exhibitors:write
      • survey/surveys:read
      • survey/surveys:write

Creating an OAuth Application

After you have set up a Workspace and invited them, developers can sign up and create a custom OAuth app. See Creating a Custom OAuth Application for a procedure.

Connecting to Cvent

After creating an OAuth application, set the following connection properties to connect to Cvent:

  • InitiateOAuth: GETANDREFRESH. Used to automatically get and refresh the OAuthAccessToken.
  • OAuthClientId: The Client ID associated with the OAuth application. You can find this on the Applications page in the Developer Portal.
  • OAuthClientSecret: The Client secret associated with the OAuth application. You can find this on the Applications page in the Developer Portal.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9029