Skip to main content

Data Source

Follow the instructions below to create a new data flow that ingests data from an ON24 source in Nexla.
on24_api.png

On24

Create a New Data Flow​

  1. To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the desired flow type from the list, and click the Create button.

  2. Select the ON24 connector tile from the list of available connectors. Then, select the credential that will be used to connect to your ON24 account, and click Next; or, create a new ON24 credential for use in this flow.

  3. In Nexla, ON24 data sources can be created using pre-built endpoint templates, which expedite source setup for common ON24 endpoints. Each template is designed specifically for the corresponding ON24 endpoint, making source configuration easy and efficient.
    • To configure this source using a template, follow the instructions in Configure Using a Template.

    ON24 sources can also be configured manually, allowing you to ingest data from ON24 endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this source manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common ON24 endpoints. Each template is designed specifically for the corresponding ON24 endpoint, making data source setup easy and efficient.

Endpoint Settings​

  • Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.

    Get a List of Events for a Client

    This endpoint template retrieves a listing of events for a particular client from your ON24 account. Use this template when you need to retrieve event information, event details, or event metadata for your ON24 virtual events and webinars. Events belonging to sub-client accounts are not included in the response.

    • This endpoint automatically retrieves all events for your ON24 client. No additional configuration is required beyond selecting this endpoint template. The endpoint uses incrementing page-based pagination to handle large datasets efficiently.

    This endpoint retrieves a listing of events for your ON24 client. The endpoint uses incrementing page-based pagination with pageOffset and itemsPerPage parameters to handle large datasets efficiently. Nexla will automatically fetch subsequent pages of data by incrementing the page offset. The endpoint returns up to 100 events per page by default.

    Events belonging to sub-client accounts are not included in the response. For detailed information about event management, API response structures, pagination, and available event data, see the ON24 API documentation.

    Get a List of Attendees for a Client

    This endpoint template retrieves a listing of attendees for a particular client from your ON24 account. Use this template when you need to retrieve attendee information, attendee details, or attendee registration data for your ON24 virtual events and webinars.

    • This endpoint automatically retrieves all attendees for your ON24 client. No additional configuration is required beyond selecting this endpoint template. The endpoint uses incrementing page-based pagination to handle large datasets efficiently.

    This endpoint retrieves a listing of attendees for your ON24 client. The endpoint uses incrementing page-based pagination with pageOffset and itemsPerPage parameters to handle large datasets efficiently. Nexla will automatically fetch subsequent pages of data by incrementing the page offset. The endpoint returns up to 100 attendees per page by default.

    For detailed information about attendee management, API response structures, pagination, and available attendee data, see the ON24 API documentation.

Endpoint Testing​

Once the selected endpoint template has been configured, Nexla can retrieve a sample of the data that will be fetched according to the current settings. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Configure Manually​

ON24 data sources can be manually configured to ingest data from any valid ON24 API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations.

With manual configuration, you can also create more complex ON24 sources, such as sources that use chained API calls to fetch related data or sources that require custom query parameters or filters.

API Method​

  1. To manually configure this source, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the ON24 API from the Method pulldown menu. ON24 API typically uses GET method for retrieving data from endpoints.

API Endpoint URL​

  1. Enter the URL of the ON24 API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL including your API base URL (from your credential), the API path (e.g., /v2/client/{client_id}/event), and any required query parameters (e.g., https://api.on24.com/v2/client/{client_id}/event?itemsPerPage=100). Include any required query parameters in the URL.

Ensure the API endpoint URL is correct and accessible with your current credentials. The ON24 API uses incrementing page-based pagination with pageOffset and itemsPerPage for some endpoints. The endpoint URL should include your client ID. You can test the endpoint using the Test button after configuring the URL.

Response Data Path​

  1. Enter the JSONPath expression in the Response Data Path field to specify which part of the API response should be treated as the relevant data by Nexla. For ON24 API responses, use $.events[*] to extract all events from the events array, or $.attendees[*] to extract all attendees from the attendees array, depending on your endpoint.

The JSONPath expression must correctly reference the structure of your ON24 API response. ON24 API responses may have different structures depending on the endpoint. Ensure your JSONPath expression matches the structure returned by your specific endpoint. The JSONPath expression determines which data will be extracted and processed by Nexla.

Pagination (if applicable)​

  1. If your endpoint supports pagination, configure the pagination settings in the Pagination section. ON24 API uses incrementing page-based pagination with pageOffset and itemsPerPage for most endpoints. Select the pagination type that matches your endpoint's pagination mechanism.

  2. Configure the pagination parameters based on your selected pagination type. For incrementing page-based pagination, specify the page offset parameter name (pageOffset), the starting offset value (0), and the page size parameter name (itemsPerPage).

Save the Data Source​

  1. Once all of the relevant steps in the above sections have been completed, click the Next button to proceed with the rest of the data flow configuration, or click Save to save the data source configuration for later use.