Installation and Configuration
This guide will assist you with configuring CSI Cloud’s Cvent integration. The goal is to make sure you understand and have taken all the steps necessary for the integration to work autonomously. This guide will walkthrough steps to take on Cvent followed by steps for CSI Cloud. Note that some steps can be worked on in parallel.
Steps to Perform At Cvent
You only need to set this up once. It is account wide.
Do the following to set up a webhook:
- Log in to the Cvent app.
- Make sure at least one event is created.
- Select Admin from the nine squares in the top right.
- Go to Integrations > Push API Integrations.
- Click Create Integration:
- Name - CSI
- Type - Webhooks
- Default Endpoint - https://cvent.cloud.csiinc.com/api/webhooks
- Connection Type - Token based
- Authentication Token - Found on the CSI Cloud Dashboard under Account
- Click Save.
- Click Edit.
- Update the Activate the configuration for setting to Yes.
- Check the Synced Objects.
- Click Save.
- Check the Integration Points.
- Add at least these integration points:
- Invitee/Guest Registered for Event
- Invitee/Guest Event Registration Cancelled
- Invitee/Guest Event RegistrationModified
- InviteeSubstitutedInAnEvent (if you plan on substituting registrants)
- Click Save.
- All new events will now have the integration upon creation. Any existing events must be updated:
- Navigate to Events > [your event] > Integrations.
- Click Setup for Webhooks.
- Click Add Webhook.
- Select the previously created integration/configuration from the drop down.
- Click Save.
How to Enable Custom IDs for Each Event
Do the following to enable custom IDs for each event:
- In an event, navigate to Registration > Registration Process > Open Site Designer.
- From the Registration Page drop-down, click the gear icon next to the Registration Path(s).
- Scroll to the External Data Source section and select Cvent in the drop-down.
Steps to Perform on the CSI Cloud Dashboard
Log In to the Cloud Dashboard
Navigate to https://cloud.csiinc.com/
- Username: The username in your iMIS environment (Typically the manager account or admin)
- Password: The password for this account.
- CSI Cloud ID: This is the Alias for your iMIS instance. This would be given to you by CSI. Learn more.
Create the Connection to Cvent
- Select Cvent from either Your Apps or from the left banner under Connectors.
- If you do not see Cvent, then you may need User Assignments to be updated.
- Select Update User Assignments.
- Under Cvent, add the desired user (possibly yourself) and select Assign User.
- If you click on Cvent via the side banner, you will be presented with a sub-menu (Overview, Events, Registration iPart, Account, Logs). Overview is most common. If you are setting up your account, click Account.
Set Up Your Cvent Account
After navigating to the Cvent Account information you will see the following data points:
- Cvent Account Name: This is supplied to you by Cvent.
- API Username: This is supplied to you by Cvent (or created by you through their site)
- SOAP API URL: This is Cvent’s API URL. Supplied to you by Cvent. This should remain fairly static.
- Registration URL: This is Cvent’s Registration URL. Again, this should be static.
- Webhooks Authentication Token: This will be created for you automatically. This allows Cvent to authenticate with your iMIS data.
- Last Updated On: The date/time account information was last updated.
Important! These fields must be filled in order for the CSI Cloud application to work properly.
Cvent Events
The Events page allows you to add or edit events, provided they are setup in Cvent.
Adding an Event
- Click Add New.
- Multiple fields will appear:
- Cvent Event Code: This will be the event code created by Cvent for the specific event. Based on your account setup, you can use the SELECT button to select the event from Cvent that you want to setup. You are also able to manually enter your Cvent Event Code.
- iMIS Meeting Code: This is the meeting/event code from your iMIS event that has been setup that you want to link with Cvent. You will be able to use the SELECT button select your iMIS event. You are also able to manually enter your iMIS Event Code.
- Registrants IQA Path: This allows you to specify the iMIS IQA for the list of registrants allowed to register for this meeting. You must have an IQA that matches the result set for Cvent Standard Service. A SELECT button is also active for this data point and is recommended.
- The select button will open the IQA screen.
- Navigate to the desired Cvent IQA.
- It is recommended to run the IQA to make sure it works before selecting it.
- As a reminder, after clicking Find, the IQA should return one result if the person is allowed to register and no results if they are not allowed to register.
- Once tested, click Close then Select.
- Allow Anonymous Registration: This will allow the user to register for the event from within the Cvent application without regard for who they are or whether they are allowed to register or not.
Note: If the event is Pending, then click Include inactive events after clicking Select to have it appear in the search.
Note: You do not need to setup an Event in iMIS for this integration to work, but you need to enter a distinct meeting code.
Note: Information on creating or importing a sample Cvent IQA can be found here.
How the event appears in iMIS
After the user registers with Cvent, the registration will appear as an activity of type meeting. This may be able to be viewed from a contact’s Participation tab. If it is not visible on the Participation tab, an IQA query will have to be created.
Note: Participation tabs may be set up differently depending on the panel(s) that create the page. Therefore, even if the activity was successfully imported to the account, it may not appear on this page and an IQA query may need to be made.
Creating the IQA query
Do the following to create the IQA query:
- Go to RiSE > Intelligent Query Architect
- Select the folder the IQA query will reside in.
- Select New > Query.
- For more detailed documentation on creating an IQA query, see the iMIS documentation.
- (Summary tab) Enter a Name.
- (Sources tab) Add the NetContactData and CsActivity sources with the following join: NetContactData.Id = CsActivity.Id
- (Filters tab) Add the following filters, all with In Search? set to Optional:
- [NetContactData] Id
- [NetContactData] First Name
- [NetContactData] Last Name
Tip! Continue adding search filters that will enable you to search for the desired contacts.
- (Display tab) Add in the following display properties:
- (required) [CsActivity] Activity Type
- (required) [CsActivity] Description
- (optional) [NetContactData] Id
- (optional) [NetContactData] Full Name
- (optional) [CsActivity] Transaction Date
- Click Save.
When running the IQA query, enter in the information of the registrant. If they are registered in Cvent and the CSI Cloud Cvent integration product is properly set up, the activity should appear in the query.
Troubleshooting
Member Unable to Register via RiSE iPart
If a member receives a message stating “Could not confirm registration information for iMIS ID: [iMIS ID]”, then the Registrant IQA path does not allow them to register.
This IQA path can be checked by navigating to CSI Cloud Cvent application > Events > [specific event] > Registrant IQA Path. If the member is allowed to register, the IQA query should return one result when the member’s information is entered into it.
Registrations Not Appearing in iMIS
Check the CSI Cloud Logs
This will show whether or not the webhook is being called, and if so, with what information.
In the CSI Cloud Cvent application, navigate to Overview > Logs, then use the banner to select Webhook.
Here, you will be able to determine whether the webhooks from Cvent to CSI Cloud are being activated. If there are no webhooks on the logs, please double check the Cvent Event’s Webhook Integration as well as the CSI Cloud Cvent application’s Cvent code. Where to find both can be found in the documentation above.
Whitelist the Cvent App IP Addresses
In the remote event that your webhooks may not be working, Cvent may have to Whitelist the following IP addresses in your Cvent account settings in order for the CSI Cvent app to successfully communicate with the Cvent APIs:
IP Address |
Description |
---|---|
23.96.247.82 |
CSI Cloud API Router |
50.236.23.134 |
CSI Office (for troubleshooting and debugging) |
173.161.104.49 |
|
23.96.220.94 |
Cvent App - Outbound IP See more from Full List below |
23.96.219.103 |
|
23.96.221.106 |
|
23.96.219.121 |
|
23.96.220.116 |
Cvent App - Inbound IP |
23.96.189.6 |
Load Balancer for Data Processor |
Full List Of Cvent App - Outbound IP:
23.96.220.94,23.96.219.103,23.96.221.106,23.96.219.121,23.96.227.203,157.55.166.62,157.55.166.169,157.55.170.179,157.55.171.196,23.96.220.116,52.162.107.25
Find Your SOAP API Credentials
You may need to call Cvent to provide you with your SOAP API Credentials. This will allow us to access your Cvent information using the SOAP endpoint (North America Only): https://api.cvent.com/soap/v200611.asmx
If you are not in North America, please find your API url here: SOAP API Archives - Cvent | Developer Hub Send CSI a help ticket @ support@csiinc.com so that they can change this in the configuration.
To review your SOAP API Usage and configuration, go to Admin > Integrations > SOAP API Usage
Ensure our CSI Clout Router server IP addresses are whitelisted to the SOAP API. Click on the dropdown next to the API username to validate the Allowed IP Addresses.
Confirm Your Standard Service Support
You may need to call Cvent to confirm they have enabled this feature for you. It is also known as HTTP POST Process for Events which allows us to provide you with a Single Sign On experience.
Typically a form is submitted via HTTP Post on your behalf at this URL: https://www.cvent.com/events/apis/reg.aspx
This is used by our registration iPart (and custom Web User Control) to authenticate members for the Cvent meeting.
Contacting CSI Support
If you are still having an issue, you may contact CSI support via our Support Request Form.