Skip to main content

Cvent Integration Setup Guide

Cvent Integration Training Guide

  1. Prerequisites
  2. Integrating Cvent into CMS
  3. Webhooks
  4. Post configuration
  5. Custom Fields
  6. Useful Links/NotesLinks

 

Prerequisites to integrate with CMS

 

How to integrate Cvent with CMS

Before you initiate the integration you will need to set up an Application in the Cvent Developer Portal. Within the Application, you may select all of the EVENT scopes (please click on the link for more information https://developers.cvent.com/documentation/rest-api/). However, access to ALL scopes is not essential, the minimum required are as 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”Integrations
  • Click on the “Cvent”Cvent tile

Picture.png


Next you will need to populate the cms fields with the relevant information

  1. Client I.D – can be obtained from Cvent Developer Portal after an Application has been created
  2. Client Secret – can be obtained from Cvent Developer Portal after an Application has been created
  3. Host – the Endpoint host varies based on which server region your 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
  4. Event I.D – can be obtained from the Cvent Events Portal
  5. Session Import Method – a 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 Agenda – Your Cvent session will be imported to your delegate’s favourited agenda. Please refer here to read more about Personal Agenda.
  6. Default People Group – the default people group to which all Cvent attendees will be added
  7. Two Two-Way Integration Toggletoggle – switch on this toggle of you want to sync cms data into Cvent, otherwise by default attendee data will only pull from Cvent into the cmsCMS

    On a two way integration, we can only sync changes to attendee details to Cvent, but we cannot sync changes to session details back to Cvent

Picture1.png

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

A module named Cvent agenda will be created in the CMS after the integration is set up. Do not delete this module if you want to sync your Cvent sessions into the cms (refer to Setting up the webhook configuration section below)


Setting up webhooks

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

Syncs from Cvent to CMS can take up to 20 minutes. Syncs from CMS to Cvent is more or less instant

After you have clickedsaved savethe integration details in the CMS you will then be shown the “Webhooks”Webhooks section which contains the “Webhook URL”URL and “Webhook Token”Token

Picture8.png

1. Adding a webhook configuration

  • In the Cvent Event Portal

    • Clickgo onto “Admin”Admin (Top> rightIntegrations corner> –Integrations drop> downPush menu)API Integrations
    • Click on “Integrations”
    • Click on “Push API Integrations”
    • Click on “Create Integration”Integration
    • Add “Name”Name
    • Choose Type “Webhooks”Webhooks
    • Add the Default Endpoint –which is the Webhook URL from the CMSPicture3.png
    • Choose Connection Type:Type select “Token Based”Based
    • Add the Authentication Token –which is the 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”Save

    Cvent2. EventSetting Portalup the webhook configuration

    • Click on “Integrations”the name of your Webhook configuration you just created
    • Click on “PUSH API Integrations”
    • Click “Edit”Edit on Webhooks
    • Select Yes for Active Webhook? YES
    • ConfigurationSelect “ChooseNo Eventfor you require”Default
    • Synced Objects (Click
      • Attendees YES- foralways select Yes
      • Sessions &- Attendees)select Yes if you want to sync session details, if not select No

    Picture4.png

    • Click “SAVE”Save

    3. Adding Integration Points for data to be transferred

    • In your webhook configuration under the Integration Points tab click on Add Integration Point
    • Integration points to add:
      •  Sessions
        • Session Created
        • Session Modified
        • Session Delete
      • Invitees
        • Invitee or Guest Accepted
        • Invitee or Guest Modified
        • Invitee or Guest Cancelled
        • Invitee or Guest Registers for Session
        • Invitee or Guest Cancels Registration for Session

    The API will only process the following webhook event types:

    InviteeOrGuestModified
    InviteeOrGuestCancelled
    InviteeOrGuestAccepted
    InviteeRegistersForCventSession
    InviteeCancelsRegistrationForCventSession
    SessionCreated
    SessionUpdated
    SessionDeleted

    • Click Save

    4. Activating Webhooks for your event

    • Navigate to your event and click on Integrations
    • Find the Webhooks integration and click on Set Up
    • Click Inactive webhooks, then click Edit on the next page
    • Select Yes for Activate webhooks for this event
    • Select your webhook configuration in the Configuration dropdown
    • Click Save

    For each event you want to integrate with a CrowdComms app you need to set up a new Webhook configuration

     

    Post configuration
    • Only attendees with the status Accepted will be added to the CrowdComms app
    • Existing attendees will be removed from the app if:
      • their status changes to other than Accepted
      • they are cancelled on Cvent and an InviteeOrGuestCancelled webhook is received
    • In a two-way integration data will be synced back to Cvent only for attendees who have been added to the CrowdComms app via the integration
    • In a two-way integration removing attendees from the CrowdComms app will not affect the Cvent platform. You need to manually remove attendees from Cvent

     

    Custom Fields

    Upon successful integration only delegate's First Name, Surname and their Email is automatically synced, all other information needs to be set up using the Custom fields tab.

    Click on the “Custom Fields” TAB in CMS

    Picture5.png

    Picture9.png

    • PeopleThe Group
    • CustomCvent Field
    • Persondropdown Field
      • will

    Indisplay caseadditional ofdata athat 2has waynot integrationalready webeen aremapped unableautomatically, which you can manually map to push back changes into Cvent on the followingDashboard. fields:

    Some
    • profileImageUrl
      • examples
    • homeCountry
      • include:-
    • workCountryAddress,
      • telephone,
    custom
    • Cventfields, agendaor willregistration createtypes which you may have added in CMS AFTER the integration is set up - this should NOT be deleted. 
      Cvent
    • You can add as many custom fields as you wish
    • Registration Type can only be linked to a People Group
    • Cvent Contact Custom field can only be linked to a CC Custom field or a Person Field
    • ONLY

    In 1stcase 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 receiveof 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-two-way integration we onlyare pushunable backto sync changes forinto attendeesCvent that have been added toon the appfollowing throughfields:
    profileImageUrl
    homeCountry
    workCountry the

    Cvent
     integration

    • Useful links
    • 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.

    WhereHow to set up Webhooks?an ThisApplication path inon Cvent developer Classic experience: Admin > Integrations > Integrations > Push API IntegrationsNew experience: Admin > Integrations > Push API Integrations 

    Portal
    https://developers.cvent.com/documentation/rest-api/developer-quickstart/


    More

  • How informationto inset theup link below

    Webhooks
    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