eventScribe API

Overview

An API key must be used to consume this web API. An API key is unique per event, per third-party vendor and must be contracted by the client. Read the EventTech REST API Overview article for information about client expectations when contracting API access for a third-party vendor. 

Download the technical API documentation attached at the bottom of the page.

IMPORTANT CHANGE: Use this endpoint instead of what's listed in the documentation: 

https://integrations.mycadmium.com/webservices/eventScribeAPIs.asp

Frequently Asked Questions

• This API is mostly used to PUSH user data TO eventScribe
  • Vendors that have pushed to the eventScribe API in the past:
    • eventPower
    • MCI
    • Showcare
    • Spargo
• getAccount Method can only be used to pull a single account at a time. There is currently no way to pull eventScribe users in bulk. The membership or registration system should remain the source of truth for the client's attendance data
• AccountAccessLevel is case sensitive; the first letter must be capitalized. Acceptable values are “Basic” or “Standard” or “Premium”
• cancelAccount and deleteAccount work the same. We don't actually "cancel" accounts. We delete them, but they can be restored on the Focus: Deleted view of the users list
• Favorites
  • Yellow vs. Blue - Definitions
    • A yellow favorite can be added/removed by the end-user and is meant to show interest
    • A blue favorite cannot be added/removed by the end-user and is meant to indicate a purchase (i.e. for a ticketed workshop)
  • addRemoveFavorite Method
    • Can be used to send yellow or blue favorites 
    • Can send an array of presentation IDs
    • To send a blue favorite, use "ticketed" : true; the default value is "ticketed" : false
    • When you remove a favorite, it doesn't care about ticketed true/false
  • Two unique ID options - third-party should only pass one
    • id = Education Harvester PresentationID (preferred)
      • Third-party can pull this information from the Education Harvester API or client can provide a report with this information
    • externalID = Unique ID set by third-party
      • Client will need to add these IDs to a worksheet in Education Harvester to the field 'Presentation External ID'
  • addUpdateAccount Method can only pass blue favorites
  • Testing Notes:
    • When you add yellow favorites, it will update in real-time, if the user refreshes their screen
    • When you add blue favorites, the user must log out and back in to refresh
    • When you remove yellow OR blue favorites, it will update in real-time, if the user refreshes their screen
• Survey Magnet
  • Users can be pushed to eventScribe and then eventScribe syncs with Survey Magnet. If the client is using Survey Magnet, consideration should be made when pushing users to eventScribe 
  • If the client plans to use tasks (i.e. to create groups of evaluations) in Survey Magnet (i.e. In-Person vs. Virtual vs. Both), then it's a good idea to pass values to the Reg Items field, as this is what we use to filters tasks
  • A single Unlock Code can be used to lock down an individual evaluation. The Survey Magnet does NOT support multiple unlock codes assigned to the same evaluation
  • Survey Magnet does NOT support user access levels like eventScribe does