Automate Tasks in Power Automate Using the CData API Server
Power Automate (Microsoft Flow) makes it easy to automate tasks that involve data from multiple systems, on premises or in the cloud. With the CData API Server, line-of-business users have a native way to create actions based on Cvent triggers in Power Automate; the API Server makes it possible for SaaS applications like Power Automate to integrate seamlessly with Cvent data through data access standards like Swagger and OData. This article shows how to use wizards in Power Automate and the API Server for Cvent to create a trigger -- entities that match search criteria -- and send an email based on the results.
Set Up the API Server
Follow the steps below to begin producing secure and Swagger-enabled Cvent APIs:
Deploy
The API Server runs on your own server. On Windows, you can deploy using the stand-alone server or IIS. On a Java servlet container, drop in the API Server WAR file. See the help documentation for more information and how-tos.
The API Server is also easy to deploy on Microsoft Azure, Amazon EC2, and Heroku.
Connect to Cvent
After you deploy, provide authentication values and other connection properties by clicking Settings -> Connections in the API Server administration console. You can then choose the entities you want to allow the API Server access to by clicking Settings -> Resources.
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 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 the Creating a Custom OAuth Application section in the Help documentation for more information.
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 Cvent Developer Portal.
- OAuthClientSecret: The Client secret associated with the OAuth application. You can find this on the Applications page in the Cvent Developer Portal.
You will also need to enable CORS and define the following sections on the Settings -> Server page. As an alternative, you can select the option to allow all domains without '*'.
- Access-Control-Allow-Origin: Set this to a value of '*' or specify the domains that are allowed to connect.
- Access-Control-Allow-Methods: Set this to a value of "GET,PUT,POST,OPTIONS".
- Access-Control-Allow-Headers: Set this to "x-ms-client-request-id, authorization, content-type".
Authorize API Server Users
After determining the OData services you want to produce, authorize users by clicking Settings -> Users. The API Server uses authtoken-based authentication and supports the major authentication schemes. You can authenticate as well as encrypt connections with SSL. Access can also be restricted by IP address; access is restricted to only the local machine by default.
For simplicity, we will allow the authtoken for API users to be passed in the URL. You will need to add a setting in the Application section of the settings.cfg file, located in the data directory. On Windows, this is the app_data subfolder in the application root. In the Java edition, the location of the data directory depends on your operation system:
- Windows: C:\ProgramData\CData
- Unix or Mac OS X: ~/cdata
[Application] AllowAuthtokenInURL = true
Add Cvent Data to a Flow
You can use the built-in HTTP + Swagger connector to use a wizard to design a Cvent process flow:
- In Power Automate, click My Flows -> Create from Blank.
- Select the Recurrence action and select a time interval for sending emails. This article uses 1 day.
- Add an HTTP + Swagger action by searching for Swagger.
- Enter the URL to the Swagger metadata document:
https://MySite:MyPort/api.rsc/@MyAuthtoken/$oas
- Select the "Return Events" operation.
Build the OData query to retrieve Cvent data. This article defines the following OData filter expression in the $filter box:
Virtual eq 'true'
See the API Server help documentation for more on filtering and examples of the supported OData.
Trigger an Action
You can now work with Events entities in your process flow. Follow the steps to send an automated email:
- Add an SMTP - Send Email action.
- Enter the address and credentials for the SMTP server and name the connection. Be sure to enable encryption if supported by your server.
- Enter the message headers and body. You can add Cvent columns in these boxes.