Establishing a Connection
The objects available within our connector are accessible from the "cdata.cvent" module. To use the module's objects directly:
- Import the module as follows:
import cdata.cvent as mod
- To establish a connection string, call the connect() method from the connector object using an appropriate connection string, such as:
mod.connect("InitiateOAuth=GETANDREFRESH;OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;")
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:- Sign into Cvent and navigate to App Switcher (the blue button in the upper right corner of the page) > Admin.
- In the Admin menu, navigate to Integrations > REST API.
- A new tab launches for Developer Management. Click on Manage API Access in the new tab.
- 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 connector, 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.