Things to Know

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 REST 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

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.

Note: 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.

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"

Set Up

Find set up instructions in our reference guide for ON24 REST API here. 

Registration

Optional

Find external registration instructions in these links: 

• Unified Seamless Registration
• REST Registration API for Webinars

Timing

Implementation Timing

The completion time to build a custom data integration leveraging ON24’s REST API will vary according to your resources’ availability. Since this is custom built, ON24 does not participate in its development.  

Contact Support if you have questions about the data.  

Scheduled Timing

Scheduled timing is when the data passes from ON24 to your end system.  Using REST API, you define when your integration runs.

Note: Scheduled timing is different from Availability Timing.

Availability Timing

Availability Timing refers to when data is available in the data warehouse for the integration platforms to collect.

Timing may fluctuate on heavy traffic days.

• Registrant - 15 minutes
• Attended Live - 30 minutes to 2 hours after the event ended
• Attended On-demand - 4 to 12 hours

Data is processed and made available in a defined order based on business relevance. 

• Registrant data is prioritized and becomes available first. Attendee data follows once event activity has fully completed and reporting is finalized.
• Within attendee data, live event information is prioritized ahead of on-demand activity due to its immediate relevance. On-demand data is processed after live data and appears once all reporting is complete.

This prioritization ensures that the most relevant and time-sensitive information is available first, while maintaining consistent and reliable reporting across all data sets.

Note: Availability timing is different from Scheduled timing.

Backfills

A backfill is the process of obtaining historical records for your end system.  

You can build a custom solution using our REST API to run a backfill. You can go as far back as your ON24 contract start date. However, the data can only be pulled 6 months at a time. 

Advanced Analytics customers – you can manually export the last 2 years of data from the ON24 platform and import it into your integration.

In the Analytics tab of your ON24 account, click on Power Leads to export the data. 

FAQs