iVvy Developer API
  • API Documentation
  • Getting Started
    • Obtaining Keys
    • Creating the request
      • Method/URI Header
      • Request Headers
        • Standard Headers
        • Custom Headers
      • Signing the request
      • Query Parameters
    • Test Ping
    • Interpreting the response
      • Collections
      • Pagination
      • Filtering
      • Exceptions
      • Response Headers
      • Dates
    • Batch
      • Run
      • Progress
      • Result
      • Restart
      • Repost
    • Use Cases
      • CRM Systems
      • Financial Accounting Systems
      • Point Of Sale
      • Property Management Systems
  • Contacts & Companies
    • Get Contact List
    • Get Contact
    • Get Contact Note List
    • Add or Update Contact
    • Get Contact Custom Field Definition
    • Get Company Custom Field Definition
    • Get Subscription Group List
    • Add Contacts To Subscription Group
    • Remove Contacts From Subscription Group
    • Get Company List
    • Get Company
    • Get Company Note List
    • Add or Update Company
    • Add or Update Lead
    • Add or Update Contact Note
    • Add or Update Company Note
  • Event
    • Add or Update Event
    • Get Event List
    • Get Event
    • Get Registration
    • Get Registration List
    • Get Attendee
    • Get Attendee List
    • Get Invited Contact List
    • Invite Contacts
    • Get Sponsorship List
    • Get Speaker List
    • Get Session List
    • Create Login Token
  • Venue
    • Venue Setup Data
      • Get Venue
      • Get Venue List
      • Get Venue Room List
      • Get Venue Room Option List
      • Get Venue Rate Plan List
      • Get Venue Rate Plan Rate List
      • Get Venue Rate Plan Room Rate List
      • Get Resource List
      • Get Resource Availability
      • Get Menu List
      • Get Beverage Package List
      • Get Function Space List
      • Get Space Blockout List
      • Get Function Space Category List
      • Get Function Space Availability
      • Get Function Space Hire Plan Rate List
      • Get Function Space Hire Plan Rate
      • Get Cost Center List
      • Get Session Type List
      • Get Revenue Template List
      • Get Tax List
      • Add or Update Function Space
      • Get Event Type List
      • Add or Update Function Space Category
      • Add or Update Guest Room
      • Get Booking Custom Field List
      • Get Space Hire Plans
      • Get Venue Package List
      • Get Venue Package
    • Booking Data
      • Convert Lead To Opportunity
      • Add or Update Opportunity
      • Get Booking
      • Get Booking List
      • Get Booking List For Account
      • Get Booking Notes
      • Get Booking Session List
      • Get Booking Session Menu List
      • Get Booking Changelog List
      • Get Booking Attendee (By Hash)
      • Get Booking Attendee List
      • Get Booking Release Schedule
      • Add or Update Booking
      • Change Booking Status
      • Add Items To Booking
      • Add Payment To Booking
      • Add Refund To Booking
      • Add or Update Booking Attendee
      • Add or Update Booking Note
      • Add or Update Booking Session
      • Add or Update Booking Session Beverage
      • Add or Update Booking Session Menu
      • Add or Update Booking Session Resource
      • Remove Booking Session
      • Remove Booking Session Beverage
      • Remove Booking Session Menu
      • Remove Booking Session Resource
      • Get Space Blockout List
      • Add or Update Blockout Space
      • Remove Blockout Space
      • Get Booking Tax List
      • Add or Update Opportunity Note
      • Upload Booking Document
    • Booking Accommodation Data
      • Get Booking Accommodation List
      • Add or Update Booking Accommodation
      • Remove Booking Accommodation
      • Get Booking Room Reservation List
      • Add or Update Booking Room Reservation
      • Update Room Reservation Guest Contact
      • Remove Booking Room Reservation
      • Confirm Booking Room Reservation
      • Cancel Booking Room Reservation
      • Change Status of Booking Room Reservation
      • Add or Update Room Counts
      • Add or Update Room Dynamic Rates
      • Remove Room Dynamic Rates
      • Add or Update Rate Plan Booking Rules
  • Partner
    • Get Venue List
    • Get Venue
  • Invoice
    • Get Invoice List
    • Get Invoice
    • Get Options
    • Add Payment
    • Get Credit Note List
    • Get Credit Note
  • Account
    • Add or Update Cost Center
    • Get Cost Center List
    • Get Email Log List
    • Add Error Report
    • Get Account User List
  • CRM
    • Get Lead List
    • Get Opportunity List
    • Get Opportunity Note List
    • Get Task List
    • Get Activity List
    • Get Lead Stage List
    • Get Lead Type List
    • Get Lead Quality List
    • Get Lead Source List
    • Get Lead Channel List
    • Get Lead Note List
    • Add or Update Activity Purpose
    • Add or Update Activity
    • Add or Update Task
    • Add or Update Lead Quality
    • Add or Update Lead Stage
    • Add or Update Lead Channel
    • Add or Update Lead Type
    • Add or Update Lead Source
    • Add or Update Lead Note
  • Notifications
    • Company Endpoint
    • Contact Endpoint
    • CRM Endpoint
    • Invoice Endpoint
    • Booking Endpoint
    • Event Endpoint
  • Development Reference
    • Calculating md5
    • HMAC-SHA1
    • JSON Encoding
    • Timestamp Format
    • Date Format
    • Time Format
    • Address Format
    • URLEncoding
    • Timezone List
  • Announcements
    • Room Reservation Contact Changes
    • Contact Customfield Changes
    • Booking Accommodation API Changes
Powered by GitBook
On this page
  • CRM Integrations
  • Contacts
  • Contact Emails
  • Event Software Users
  • Event Registrations
  • Events
  • Event Attendees
  • Venue Software Users
  • Companies
  • Quotes and Bookings
  1. Getting Started
  2. Use Cases

CRM Systems

PreviousUse CasesNextFinancial Accounting Systems

Last updated 3 years ago

CRM Integrations

CRM Integrations typically have different modules completed in them for transfer.

  • ``

Contacts

Contacts are preferred to be transferred two ways between iVvy and the CRM system so that both systems are always kept up to date.

It is important to remember that iVvy uses three fields to uniquely identify a contact: first name, last name and email. Other systems may not use the same identifiers, so it is recommended that a constant identifier is used (such as a contact ID) to make a permanent pairing of the contacts. iVvy does have a field to store a externalId that our integrations typically use to store the contact ID from the other system.

Typical endpoints used when doing a 2 way contact sync.

Remember to provide a method to map custom fields between the two systems if they are also being synced in the integration.

Contact Emails

As an email is usually stored against a singular action in iVvy, they cannot be received into iVvy from a third party. So contact emails are a one way sync out of iVvy and into the CRM so that the CRM has a comprehensive history of all correspondence sent to the contact.

Typical endpoints used when doing an email sync from iVvy to a CRM:

Event Software Users

If completing a integration for Events users, these are some optional modules that have been popular demand.

Event Registrations

Event registrations are usually synced into the CRM as opportunities. This is normally optional so that the user can use the CRM portion and not be forced into this feature if they do not wish to use it.

This is associated with the revenue of event registrations being displayed in the CRM system so that more accurate forecasting is completed. It also attaches to the contacts/companies history so that the CRM user can see an accurate historic relationship with the contact/company. This is a one way sync out of iVvy and into the CRM system.

Typical Endpoints used when doing an Event Registration syncs into Opportunities in a CRM.

Usually only paid “completed” status registrations would be synced, because until payment is received they are not guaranteed as income.

Events

Events are synced one way out of iVvy and into CRM campaigns. This is normally optional so that the user can use the CRM portion and not be forced into this feature if they do not wish to use it.

This gives the CRM user access to a comprehensive history of what events took place for their clients, and which of the contacts (refer campaign members) actually attended their events. This gives a more comprehensive report of the history and relationship with the customer in the CRM.

Typical Endpoints used when syncing events into a CRM.

Event Attendees

Attendees in an iVvy event are synced against the campaign in the CRM as an attendee member. This is included in the optional “Events (campaigns)” module. Part of this sync includes keeping the invitation and attendance status periodically up to date.

Typical Endpoints used when syncing event members into a CRM.

Event Registration Progress: Initially a contact would start as an invitation with the following invitation status:

  • U = Undecided

  • Y = Yes

  • N = No

If the attendee has clicked yes than they will be now found in the attendee list as they have completed their registration. Once on the attendee list (meaning they will attend) the “hasAttended” and “sessionHasAttended” flags will verify if the user registered but did or did not attend.

One point to remember is that if the event is not invite only, attendees can still register that haven’t been invited so there may be records in the attendee list that are not in the invited contact list that need to be considered.

Venue Software Users

If completing a integration for Venues users, these are some optional modules that have been popular demand.

Companies

The venues software has a component to store companies against contacts (whereas events does not) so a two way company sync (or as some CRMs refer to them as accounts) to keep the two systems up to date. The same as contacts, a company has an externalID field in iVvy that can be used as the constant to map the company together so if there is a name change, then the two companies are still connected and can be kept up to date.

Typical Endpoints used when doing a Company sync

Quotes and Bookings

Venues may wish for their quotes and bookings to appear in their CRM against the contact / company as an Opportunity. This is usually “optional” so that if the venue wishes to use the CRM, they aren’t forced to use the bookings / quotes module if they do not wish to.

iVvy does not allow for quotes/bookings to be pushed back into the system, and the data in an opportunity does not usually meet the minimum requirements of a quote or booking in the iVvy system so it’s completed as a one way sync out of iVvy and into the CRM System.

Typical Endpoints used when doing a Quotes / Bookings Sync

To get the latest bookings that have been created or modified, the result can be filtered by a modifiedDateAfter parameter.

: Using this call with a filter of modifiedDate can give you the list of contacts that were modified in iVvy since the last sync. This minimises the amount of time that is spent comparing the contacts between the two systems. You may or may not also use the get Contact action which returns a single contact.

for when the contacts are being synced back into iVvy.

list and if the integration will be supporting syncing of subscription groups.

returns a collection of the emails that have been sent. The content in the body in returned HTML format so it is wise to consider this when syncing the emails into a third party system.

can be used to fetch the latest created and modified event registrations from the iVvy system.

Important point to remember is that returned event registrations include both delegate and exhibitor registrations. The data may be filtered depending on which is being targeted. Typical iVvy integrations include both. For a list of registration status they can be found under .

returns a list of events in the iVvy account. These can then be synced into the corresponding CRM system.

gives a list of contacts invited to the event. This action will return a response on if they clicked yes, no or haven’t responded yet, however it also updates a registration ID field when the contact progresses onto a registration.

will give a list of contacts that have registered for the event.

and if completing company syncs.

, if sending data back from the third party CRM.

(this returns bookings for all venues) (returns all bookings for a single venue) or (returns a single booking) can be used to source a list of quotes and bookings out of a venue. To differentiate between a quote and a booking the current status will identify if its Prospective (quote) or Tentative / Confirmed (Booking).

Get Contact List
Add or Update Contact
Get subscription group
add Contacts to subscription group
Get Email Log List
Get Registration List
Get Event List
Get Invited Contact List
Get Attendee List
Get Company List
Get Company
Add or Update Company
getBookingListForAccount
getBookingList
getBooking
Contacts
Contact Emails
Events Software Users
Event Registrations
Events
Event Attendees
Venues Software Users
Companies
Quotes & Bookings
Registration Current Status Details