FAQs about REST API data integrations
Table of Contents
- Does ON24 push the data to the end systems?
- Why can't I find the Campaign Code field?
- How do I authenticate to the ON24 REST API?
- Does the ON24 API support multi-registration?
- What is the ON24 REST API Base URL?
- Does the ON24 API support oAuth authentication?
- Does On24 have a SwaggerUI or data dictionary describing each field type/length?
- What are the different sections in the Sample Response pages?
Does ON24 push the data to the end systems?
No. If you build a custom data integration, you will have to pull the data from ON24.
Why can't I find the Campaign Code field?
The campaigncode field is also known as eventlocation.
How do I authenticate to the ON24 REST API?
For more information please visit the following URLs:
Does the ON24 API Support multi-registration?
Not at this time. If hosting registration outside of ON24 (external), you can setup a multi-reg page, however you will have to send an API call for each webinar/event that the individual registers for. For example if a registrant selects 4 different sessions on the external registration form, there will have to be 4 calls made (one for each webinar).
What is the ON24 REST API Base URL?
For NA Database: https://api.on24.com/v2/client/
For EU Database: https://api.eu.on24.com/v2/client/
Does the ON24 API support oAuth authentication?
Not at this time. We currently support a key/secret based authentication.
Does On24 have a SwaggerUI or data dictionary describing each field type/length?
Not at this time although this is something we intend to build out in the future.
What are the different sections in the Sample Response pages?
The API documentation provides several Sample Response pages. Some of them are grouped in various sections, such as the Attendee Sample Response. The ON24 product names are associated with each section.
JSON (Elite account) - Leverage this when reviewing Elite data.
JSON (When content type is gateway) - Gateway was the former Engagement Hub (eHub) product name. Leverage this when reviewing eHub data.
JSON (When content type is experience) - Leverage this when reviewing Target data. As a reminder, Target is tied to eHub.
JSON (VE account) - Leverage this when reviewing Virtual Environment data.