Eventscribe REST API Overview

Our public APIs let you connect Eventscribe mdoule to the other tools you use, so data can flow automatically between systems instead of being exported and imported manually. An API (Application Programming Interface) is the software bridge that makes this possible — it lets one application read data from or send data to another. 

Who Builds the Integration 

Cadmium provides the APIs, credentials, and documentation — but we don't build integrations for you. The development work is done by either your in-house team or your third-party vendor. Once your contract is in place, we'll send you API credentials along with the API documentation. You'll pass both along to whoever is doing the development. If your developer has questions about how a specific API or method works, they can reach out to us at integrationservices@gocadmium.com. 

Data Exchange

Pulling Data from Cadmium

Your third party pulls data from an Eventscribe product. This is the most common setup for Education Harvester — for example, an AV company grabbing the current speaker list. You and your vendor decide together which fields to pull from, and your vendor is responsible for reading the documentation and implementing the calls. 

Pushing Data to Cadmium

Your third party pushes data into an Eventscribe product. This is the most common setup for the Eventscribe Website and Mobile App — for example, a registration platform feeding attendee data into Eventscribe. Same division of labor: you and your vendor choose which fields to push to, and your vendor handles the development. One extra responsibility on your side — because this data shows up in the live attendee experience, you'll want to review the incoming data for accuracy and test the end-user experience before your event goes live. 

NOTE

Pull and push options vary by module. Review the module-specific API documentation for details on which methods and fields are available.

Rate Limits and Best Practices 

To keep our APIs fast and reliable for everyone, we monitor traffic and may throttle or revoke access for applications that are sending excessive requests. A rate limit simply caps how many calls an app can make in a given window of time. A few things your developer should know: 

  • Standard rate limit: one call per second for most methods. 
  • Heavier methods: one call per minute for getPresentationsWithPresenters and getAllExhibitorsWithBooth, since these return large amounts of data. 
  • Use pagination on methods that return big result sets (noted in the docs) — it prevents timeouts and keeps transfers manageable. 
  • Set a sunset date in the integration code, usually your event's end date, so calls stop automatically once they're no longer needed.

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article