Eventscribe Website/Mobile App (Attendees) API

Overview

This API allows third-party vendors and registration systems to push attendee and registrant records to Cadmium.

An API key is required to consume this web API.

• API keys are unique per event and per third-party vendor
• API access must be contracted by the client
• Most API keys are event-specific
• Multi-event access can be configured upon request
• API keys are issued by Cadmium

The following vendors have previously pushed data to this API; however, this list may not be exhaustive.

• eShow
• Event Citadel (formerly CompuSystems)
• eventPower
• MCI
• Showcare
• Spargo
• Swoogo

Endpoint

Use this endpoint for ALL methods: https://integrations.mycadmium.com/webservices/eventScribeAPIs.asp

General API Requirements

Authentication Parameters

• APIKey – Provided by Cadmium
• Method – Name of API method being called
• eID – Required only if API key supports multiple events

Supported Methods

addUpdateAccount

Creates or updates eventScribe accounts.

Method Type: POST

Body: JSON array (even if sending one user)

Required Fields:

• AccountFirstName
• AccountLastName
• AccountEmail

Important Notes:

• Only send populated fields
• Avoid sending blank or null fields
• If AccountKey is not passed, the API will generate one
• AccountAssociationID can be used as a third-party unique ID
• If a matching AccountAssociationID exists, the account will be updated

Favorites via addUpdateAccount

• This method can only pass Blue (ticketed) favorites
• Use Harvester PresentationID (preferred)

cancelAccount

Sets an account to canceled.

Internally, cancelAccount and deleteAccount function the same way. Accounts are deleted but can be restored in the Focus → Deleted view of the Users list.

One identifier required:

• AccountID
• AccountAssociationID
• AccountRegID
• AccountKey

deleteAccount

Deletes an account.

Same identifier requirements as cancelAccount.

Favorite Methods

Yellow vs. Blue Favorites

Yellow Favorite

• Indicates interest
• Can be added or removed by the end-user
• Updates in real-time after refresh

Blue Favorite (Ticketed)

• Indicates purchase (example: workshop)
• Cannot be removed by the end-user
• Requires logout/login to refresh
• Use "ticketed": true

addRemoveFavorite

Adds or removes favorites from a user's account.

Method Type: POST

Body: JSON array

Requirements:

• One user identifier in querystring
• Pass either id OR externalID (not both)
• Must send an array

Presentation ID Options:

• id – Harvester PresentationID (preferred)
• externalID – Third-party unique ID

To send Blue favorite:

• Use "ticketed": true

Removing favorites:

• Use FavoriteMethod = Remove
• Ticketed value does not matter when removing

Real-Time Behavior

• Add Yellow – refresh screen
• Remove Yellow – refresh screen
• Add Blue – user must log out and back in
• Remove Blue – refresh screen

ID Mapping Guidance

Preferred ID: Harvester PresentationID

Third-party can retrieve this from:

• Education Harvester API
• Client-provided report

If using externalID:

• Client must add IDs to worksheet in Education Harvester
• Populate field: Presentation External ID

Survey Magnet Considerations

Users pushed to eventScribe will sync with Survey Magnet.

If client plans to use evaluation tasks (example: In-Person vs Virtual), pass values in:

AccountRegItems

Important Survey Magnet Notes:

• Single unlock code per evaluation only
• Multiple unlock codes per evaluation are not supported
• Survey Magnet does not support user access levels like eventScribe

Error Handling

Account Not Found

{ "error": "Account not found" }

Missing ID

{ "error": "id or externalID is required." }

Invalid JSON

{ "error": "Bad JSON string. Please make sure the object is inside an array." }

Best Practices

• Registration system remains source of truth
• Push only changed fields
• Avoid blank field overwrites
• Use Harvester PresentationID whenever possible
• Send only one account identifier
• Test Yellow and Blue favorite behavior carefully

Deprecated

getAssets method is deprecated as of Version 1.4.