CRM Integrations typically have different modules completed in them for transfer.
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.
- Get Contact List: 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.
- Get subscription group list and add Contacts to subscription group if the integration will be supporting syncing of subscription groups.
Remember to provide a method to map custom fields between the two systems if they are also being synced in the integration.
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:
- Get Email Log List 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.
If completing a integration for Events users, these are some optional modules that have been popular demand.
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.
- Get Registration List 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 Registration Current Status Details.
Usually only paid “completed” status registrations would be synced, because until payment is received they are not guaranteed as income.
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.
- Get Event List returns a list of events in the iVvy account. These can then be synced into the corresponding CRM system.
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.
- Get Invited Contact List 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.
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.
If completing a integration for Venues users, these are some optional modules that have been popular demand.
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
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
- getBookingListForAccount (this returns bookings for all venues) getBookingList (returns all bookings for a single venue) or getBooking (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).
To get the latest bookings that have been created or modified, the result can be filtered by a modifiedDateAfter parameter.