Skip to main content

Data Source

Follow the instructions below to create a new data flow that ingests data from a RingCentral source in Nexla.
ringcentral_api.png

RingCentral

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 RingCentral connector tile from the list of available connectors. Then, select the credential that will be used to connect to your RingCentral account, and click Next; or, create a new RingCentral credential for use in this flow.

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

    RingCentral sources can also be configured manually, allowing you to ingest data from RingCentral 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 RingCentral endpoints. Each template is designed specifically for the corresponding RingCentral 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.

    List Video Meetings

    This endpoint template returns the list of user meetings from your RingCentral account. Use this template when you need to retrieve information about video meetings, including meeting IDs, titles, and other meeting metadata.

    • Enter the meeting type in the Type field. This should be the type of meetings you want to retrieve (e.g., scheduled, instant, all). The meeting type determines which meetings will be returned.

    This endpoint returns the list of user meetings from your RingCentral account, including meeting IDs, titles, and other meeting metadata. The endpoint uses next token-based pagination with pageToken to handle large datasets efficiently. Nexla will automatically fetch subsequent pages of data by following the next page token returned in the API response.

    For detailed information about video meetings, API response structures, pagination, and available meeting data, see the RingCentral API documentation.

    List All Account Recordings

    This endpoint template returns all account recordings from your RingCentral account. This endpoint is used in Admin recording service, not regular web. Use this template when you need to retrieve information about account recordings, including recording IDs, titles, and other recording metadata.

    • Enter the account ID in the Account ID field. This should be the unique identifier of the account for which you want to retrieve recordings. The account ID determines which account's recordings will be retrieved.

    This endpoint returns all account recordings from your RingCentral account, including recording IDs, titles, and other recording metadata. The endpoint uses next token-based pagination with pageToken to handle large datasets efficiently. Nexla will automatically fetch subsequent pages of data by following the next page token returned in the API response.

    For detailed information about account recordings, API response structures, pagination, and available recording data, see the RingCentral 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​

RingCentral data sources can be manually configured to ingest data from any valid RingCentral 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 RingCentral 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 RingCentral API from the Method pulldown menu. RingCentral API typically uses GET method for retrieving data from endpoints.

API Endpoint URL​

  1. Enter the URL of the RingCentral API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL to your RingCentral endpoint (e.g., https://platform.ringcentral.com/restapi/v1.0/account/~, https://platform.ringcentral.com/rcvideo/v1/history/meetings). Include any required query parameters in the URL.

Ensure the API endpoint URL is correct and accessible with your current credentials. The RingCentral API endpoint URL should include the API version (/v1.0/ or /v1/) and the resource type path. 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 RingCentral API responses, use $.meetings[*] to extract all meetings from the meetings array, $.recordings[*] to extract all recordings from the recordings array, or $ to extract the entire response for single record endpoints, depending on your endpoint.

The JSONPath expression must correctly reference the structure of your RingCentral API response. RingCentral 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. RingCentral API uses next token-based pagination with pageToken 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 next token-based pagination, specify the token parameter name (pageToken) and the JSONPath expression to the next page token in the response ($.paging.nextPageToken).

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.