Skip to main content

Cvent Integration Setup Guide

Cvent Integration Training Guide

  1. Access RequirementsPrerequisites
  2. Integrating Cvent into CMS
  3. Webhooks
  4. Custom Fields
  5. Useful Links/Notes

 

Client will need access to the belowPrerequisites to integrate with CMS

  • Access to Cvent Developer Portal

at https://developer-portal.cvent.com/

  • Access to Cvent Events Portal (REST API & PUSH API within the Integrations section)

Dependsat on location (Europe or None Europe)

https://app.cvent.com

or https://app-eur.cvent.com/

    (depending on the location where the account is stored)
  • Access to CMS>Plug InsIntegrations>Cvent

 

How to integrate Cvent with CMS

  • Log

    Before intoyou CMS

  • Select App
  • Click on “Plug Ins”
  • Click oninitiate the “Cvent”integration tile
    • you

Picture.png

will

Note THE CLIENT needsneed to set up an Application in the Cvent Developer Portal. Within Applicationthe canApplication, you may select all of the EVENT scopes (please click on the link for more information on https://developers.cvent.com/documentation/rest-api/),. but if they don't want to allowHowever, access to allALL scopes,scopes is not essential, the minimum we needrequired are theas following scopes:follows:
event/events:read
event/custom-fields:read
event/registration-types:read
event/contacts:write
event/sessions:read

  • Log into CMS
  • Select App
  • Click on “Integrations”
  • Click on the “Cvent” tile

Picture.png



TheNext clientyou will need to providepopulate YOUthe cms fields with the relevant information for 1, 2, 3 and 4 below:

  1. Client I.D – Clientcan getsbe thisobtained from the Cvent developer portal (Cvent Developer Portal – created after an AppApplication has been created)created
  2. Client Secret – Clientcan getsbe thisobtained from the Cvent developer portal (Cvent Developer Portal - created after an AppApplication has been created)created
  3. Host – Dependsthe Endpoint host varies based on locationwhich (Europeserver orregion Noneyour Europe)Cvent account is hosted in. This can be also identified based on your event’s URL, starting with either https://api-platform.cvent.com or https://api-platform-eur.cvent.com (The client will be able to tell which one they need by looking at the link of there Cvent account)
  4. Event I.D – Clientcan getsbe thisobtained from the URL in Cvent Events Portal AFTER clicking on the event
  5. Session Import Method – TWOa OPTIONS;dropdown menu, which enables you to select how you would like to import your Cvent sessions to your CrowdComms Event App. The options are:
    a.  Managed Schedule – Your Cvent session will be imported to your delegate’s tailored agenda. Please refer here to read more about Managed Schedule.
    b.  Personal agendaAgenda &– ManagedYour SchedulesCvent session will be imported to your delegate’s favourited agenda. Please refer here to read more about Personal Agenda.
  6. Default People Group – Groupthe default people group to which all Cvent attendees will be added to
  7. Two Way Integration Toggle – Cventswitch on this toggle of you want to CMSsync andcms ordata CMSinto toCvent, Cvent.otherwise (by default attendee data will only pull from Cvent into the cms

    On a two way integration, we can only push back attendeesync changes to attendee details to Cvent, but we cancannot not push back sessionsync changes to Cvent)session details back to Cvent

Picture1.png

  • Once the above form is filled in, then click “Save”

 

Setting up webhooks

To allow continuous synchronization from Cvent to CrowdComms you will need to set up Webhooks in the Cvent Event Portal.

After you have clicked save you will then be shown the “Webhooks” section which contains the “Webhook URL” and “Webhook Token” (Generated automatically after you click save)

Picture8.png

The

client will then set up Webhooks using

In the generated Webhook URL and Webhook Token

Steps the client will take to set up the Webhooks in Cvent below

Cvent Event Portal

  • Click on “Admin” (Top right corner – drop down menu)
  • Click on “Integrations”
  • Click on “Push API Integrations”
  • Click on “Create Integration”
  • Add “Name”
  • Type “Webhooks”
  • Default Endpoint (– the Webhook URL from CMS)the CMSPicture3.png
  • TokenConnection (fromType: CMS)select “Token Based”
  • Authentication Token – Selectedthe Webhook Token from the CMS
  • Click “SAVE”
  • Click on the “Integration Points” TAB
  • Click on the “Add “Integration point” button
  • Add the information which is required
  • Click “SAVE”

Cvent Event Portal

  • Click on “Integrations”
  • Click on “PUSH API Integrations”
  • Click “Edit” on Webhooks
  • Active Webhook? YES
  • Configuration “Choose Event you require”
  • Synced Objects (Click YES for Sessions & Attendees)

Picture4.png

  • Click “SAVE”

 

Custom Fields

 

Click on the “Custom Fields” TAB in CMS

Picture5.png

Picture9.png

  • People Group
  • Custom Field
  • Person Field

**Note**

In case of a 2 way integration we are unable to push back changes into Cvent on the following fields:

  • profileImageUrl
  • homeCountry
  • workCountry 
  • Cvent agenda will create in CMS AFTER the integration is set up - this should NOT be deleted. 
  • You can add as many custom fields as you wish
  • Registration Type can only be linked to a People Group
  • Cvent Custom field can only be linked to a CC Custom field or a Person Field
  • ONLY 1st Name, Surname and Email is automatically pulled through, all other information needs to be set up using this.
  • Only attendees with status Accepted will be added to the cc app
  • If we receive a webhook for a previously created Cvent attendee with event type InviteeOrGuestCancelled or their status changes to other than Accepted, they will be deleted from the app
  • In a 2-way integration we only push back changes for attendees that have been added to the app through the Cvent integration
  • In a 2-way integration if an attendee that have been added to the app through the Cvent integration is deleted from the cms, we don't make a request to Cvent REST API to cancel this attendee on Cvent. If you wish to remove this attendee on Cvent you will have to do it in the Cvent dashboard.

Where to set up Webhooks? This path in Cvent  Classic experience: Admin > Integrations > Integrations > Push API IntegrationsNew experience: Admin > Integrations > Push API Integrations 

https://developers.cvent.com/documentation/rest-api/

More information in the link below

https://developers.cvent.com/documentation/webhooks-integration-user-guide/

  • When you are setting up the Webhooks in your Cvent account with the webhook URL and webhook token from the CMS, make sure you only configure it for the event you are trying to integrate with
  • Your client needs to paste the Webhook URL and Webhook token from CMS to Cvent
  • Add the Integration points for Sessions and Invitees listed in the link below. Our api will only process the following webhook event types:

    InviteeOrGuestModified
    InviteeOrGuestCancelled
    InviteeOrGuestAccepted
    InviteeRegistersForCventSession
    InviteeCancelsRegistrationForCventSession
    SessionCreated
    SessionUpdated
    SessionDeleted

https://developers.cvent.com/documentation/webhooks-integration-user-guide/setting-up-webhooks/setting-up-your-configuration/integration-points/

Syncs from Cvent to CMS can take up to 20 minutes

Syncs from CMS to Cvent is more or less instant








Back to top