Guide for Pushing to the eventScribe API

The following information is supplemental to the eventScribe API documentation. 

The third-party vendor will need the following in order to push users to the eventScribe API:

• API Key
  • Unique per event, per vendor
  • Must be contracted by the client

Notes for Third-Party Developer

• Relevant methods:
  • addUpdateAccount
  • cancelAccount and deleteAccount do the same thing; we soft delete on our side
  • addRemoveFavorite
• Required fields:
  • AccountFirstName
  • AccountLast Name
  • AccountEmail
• UPDATE matches on the following in this order:
  1. AccountID (if third-party is storing Cadmium's AccountID)
  2. AccountAssociationID (if no AccountID is passed)
  3. AccountRegID (if no AccountAssociationID is passed)
• Typically, RegistrationID is pushed to AccountKey
  • End-user logs in with email and AccountKey. Typically clients want this value to be their registration ID
  • If no AccountKey is passed, the API will generate an 8 digit random key for this user
• AccountAccessLevel is case sensitive - Basic, Standard, or Premium
  • Access level is used to restrict site navigation and broader areas to groups of users such as press, exhibitors, etc. See the 'Resources' section below for more information
• Typically, the same values are sent to AccountUnlockCodesPDF, AccountUnlockCodesAudio, and AccountRegItems
  • These values are used to restrict presentation-level access to content. See the 'Resources' section below for more information
  • AccountUnlockCodesPDF, AccountUnlockCodesAudio, and AccountRegItems values must be separated by @@@ (i.e. TUE@@@XYZ@@@123)
• Note, if the client has Survey Magnet as well, eventScribe custom fields do not map over to Survey Magnet
• Favorites
  • A yellow-star favorite can be added/removed by the end-user and indicates interest in an agenda item
  • A blue-star favorite cannot be added/removed by the end-user and is meant to indicate a purchase (i.e. a ticketed workshop)
  • Additional information is available in the eventScribe API documentation FAQ

Client Expectations

• Cadmium does not do any development. All development is completed by the client's in-house development team or third-party vendor
• The client is responsible for working with its third-party to decide which available API fields to push data to
• The client’s third-party is responsible for reading and understanding the API documentation and its available methods
• The client is responsible for reviewing and testing all incoming data to verify accuracy and for testing the full end-user experience

Cadmium Project Manager (PM) Expectations

• PM should discuss with the client / third-party what values to push to AccountAccessLevel, AccountUnlockCodesPDF, AccountUnlockCodesAudio, and AccountRegItems based off what the client wants to restrict in eventScribe and Survey Magnet. This would be similar to if they were importing these values

Resources

• To learn more about access levels, unlock codes, and reg items, read the Registration & Access Grid Instructions article
• The client should review the Login & Customer Support Instructions article for best practices for updating end-user communications, including any Cadmium login pages, with accurate login and customer support instructions