Detailed information about ON24's REST API

What is an API?

The application program interface (API) is a set of routines, protocols, and tools for building software applications. An API specifies how software components should interact. The ON24 API makes it easier to develop a program by providing all the building blocks. A programmer then puts the blocks together. 
 

Using the ON24 REST API

• Comprehensive API documentation is available at https://apidoc.on24.com.  

• ON24 has developed a suite of REST API's that provide third parties the ability to access ON24 Webinar functionality that covers: 

  • Event Management - Create webinar, delete webinar, and much more.

  • Analytics

    • Event level - metadata & usage, registrants, and attendees

    • Client-level - event, registrants, and attendees

  • Registration - Unified Seamless registration, REST API registration, and SAML.

• With the ON24 Connect product, provision a token to access the ON24 REST API. Once created, a token key and secret will be generated. It is important protect the token key and secret from unauthorized parties accessing your data.

• All API calls must be performed server to server and not client-side via Jscript in a browser.

• When passing a country parameter, the country must match one of the values on the registration page. Click here for the full country list.

Example

The following is an example using the REST API Registration.

Please Note: for demonstration purposes, we're including a fake key and secret.  However, your own Key and Secret should be protected as you would any other credential (such as passwords, PIN's, etc).  Please don't copy/paste your credentials in emails or support tickets.

• Assume the following is correct:
  • Eventid = 1234567
  • Token Key = A11111111111111111111111111111
  • Token Secret = 9f6f711111111111111111111111111111111111111111111111111
  • Email = john@acme.com
  • Firstname = John
  • Lastname = Smith
  • Company = Acme
• When using CURL, the command string will look like this:

curl -X POST https://api.on24.com/v2/client/4497/event/1234567/registrant -H 'accept: Application/json' -H 'accesstokenkey: A11111111111111111111111111111' -H 'accesstokensecret: 9f6f711111111111111111111111111111111111111111111111111' -H 'cache-control: no-cache' -H 'content-type: application/x-www-form-urlencoded' -d 'email=john%40acme.com&firstname=John&lastname=Smith&company=Acme'

• If you do not have access to a server-side interface, there are several online tools that allow you to make HTTP requests. The online tool hurl.dev has been used with success. All you need to do is specify the appropriate values as parameters to hurl.it and it will execute a server to server call and pass the data over to ON24. The following outlines what needs to be provided to hurl.it. Other online tools will share similar usage.
• Destination:

POST
https://api.on24.com/v2/client/4497/event/1234567/registrant

Note: The Client ID and Event ID are unique values. The clientid relates to the Webcast Elite account and the eventid for the specific webinar.
 

Headers: 

accept
application/json

accesstokenkey
A11111111111111111111111111111

accesstokensecret
9f6f711111111111111111111111111111111111111111111111111

cache-control
no-cache
 

content-type
application/x-www-form-urlencoded
 

Parameters:
email=john@acme.com&firstname=John&l...h&company=Acme
 

The above will return a 200 status code and the following registration entries for event 1234567:
"firstname": "John",
"lastname": "Smith",
"email": "john@acme.com",
"company": "Acme"