Skip to main content

Avoma Data Source

The Avoma connector enables you to ingest meeting data, transcriptions, notes, and insights from Avoma. This connector is particularly useful for applications that need to extract meeting analytics, analyze conversation data, or integrate meeting insights into other systems. Follow the instructions below to create a new data flow that ingests data from an Avoma source in Nexla.
avoma_api.png

Avoma

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

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

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

    This endpoint retrieves a list of meetings from your Avoma account within a specified date range. Use this endpoint when you need to access meeting metadata, including meeting dates, participants, and associated information.

    • Enter the start date for data retrieval in the From Date field. Use the format YYYY-MM-DD (e.g., 2024-01-01). This date specifies the beginning of the date range for meetings you want to retrieve. You can also use Nexla macros like {now-30} for relative dates, which will automatically calculate the date 30 days before the current date. This is useful for creating recurring data sources that always fetch the last 30 days of meetings.
    • Enter the end date for data retrieval in the To Date field. Use the format YYYY-MM-DD (e.g., 2024-01-31). This date specifies the end of the date range. You can use macros like {now} for the current date to always fetch meetings up to today. The end date must be equal to or later than the start date.
    • The endpoint uses pagination to handle large datasets efficiently, automatically fetching additional pages as needed with a default page size of 100 records per request. If your date range contains more than 100 meetings, Nexla will automatically make additional API calls to retrieve all meetings in the specified range.

    This endpoint supports pagination and will automatically retrieve all meetings within the specified date range. The date range should be configured based on your data freshness requirements and the volume of meetings in your account. For accounts with many meetings, consider using shorter date ranges (e.g., daily or weekly) to optimize performance and reduce API load. The endpoint returns meeting metadata including meeting IDs, titles, dates, participants, and associated recording information.

    List Users

    This endpoint retrieves a list of all users in your Avoma account. Use this endpoint when you need to access user information, including user names, email addresses, and account details.

    • This endpoint automatically retrieves all users accessible to your account. No additional configuration is required beyond selecting this endpoint template.
    • The endpoint returns user data including user IDs, names, email addresses, and other account information.

    This endpoint returns all users in your organization. Use this endpoint to build user lookups or to retrieve user metadata for analysis purposes.

    List Notes

    This endpoint retrieves notes related to meetings in your Avoma account. Use this endpoint when you need to access meeting notes, action items, and other annotations created during or after meetings.

    • Enter the maximum number of notes to retrieve in the Limit field. The default value is 10, but you can adjust this based on your needs. Higher values will retrieve more notes per request, but be aware that very large limits may result in slower API responses. The limit parameter controls how many notes are returned in a single API call. If you need to retrieve all notes, you may need to use multiple requests or configure the data source to make multiple calls with different limit values.
    • The endpoint returns notes associated with meetings, including note content, creation dates, timestamps, note types (action items, key points, etc.), and related meeting information. Notes can include text content, tags, and metadata that help organize and categorize meeting information.

    The limit parameter controls how many notes are retrieved in a single request. For large datasets, consider using multiple requests with different limits or date ranges to retrieve all notes.

    List Transcriptions

    This endpoint retrieves meeting transcriptions from your Avoma account within a specified date range. Use this endpoint when you need to access full meeting transcripts, including speaker identification and timestamps.

    • Enter the start date for transcription retrieval in the From Date field. Use the format YYYY-MM-DD (e.g., 2024-01-01). You can use macros like {now-30} for relative dates.
    • Enter the end date for transcription retrieval in the To Date field. Use the format YYYY-MM-DD (e.g., 2024-01-31). You can use macros like {now} for the current date.
    • The endpoint retrieves transcriptions for all meetings within the specified date range, including full transcript text, speaker information, and timestamps.

    Transcriptions contain the full text of meeting recordings, including speaker identification and timestamps. This endpoint is useful for analyzing meeting content, extracting insights, performing sentiment analysis, or building searchable archives of meeting transcripts. The transcription data includes the spoken text, speaker names or identifiers, and timestamps for each segment, allowing you to track who said what and when during the meeting.

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​

Avoma data sources can be manually configured to ingest data from any valid Avoma 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 Avoma sources, such as sources that use chained API calls to fetch data from multiple endpoints or sources that require custom authentication headers or request parameters.

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 Avoma API from the Method pulldown menu. The most common methods are:

    • GET: For retrieving data from the API
    • POST: For sending data to the API or triggering actions
    • PUT: For updating existing data
    • PATCH: For partial updates to existing data
    • DELETE: For removing data

API Endpoint URL​

  1. Enter the URL of the Avoma API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL including the protocol (https://) and any required path parameters.

Ensure the API endpoint URL is correct and accessible with your current credentials. You can test the endpoint using the Test button after configuring the URL.

Date/Time Macros (API URL)​

Optional

Optionally, the API URL can be customized using macros—all macros added to the API URL will be converted into values when Nexla executes the API call. Macros are dynamic placeholders that allow you to create flexible API endpoints that can adapt to different time periods or data requirements.

Macros are particularly useful for APIs that require date ranges, pagination parameters, or other dynamic values that change between data ingestion runs.

  1. To add a macro, type { at the appropriate position in the API URL (within the Set API URL field), and select the desired macro from the dropdown list.

    • {now} – The current datetime
    • {now-1} – The datetime one time unit before the current datetime
    • {now+1} – The datetime one time unit after the current datetime
    • custom – Datetime macros can reference any number of time units before or after the current datetime—for example, enter (now-4) to indicate the datetime four time units before the current datetime

  2. Select the format that will be applied to datetime macros from the Date Format for Date/Time Macro pulldown menu. This format will be applied to the base datetime value of the macro—i.e., the value of {now} in {now-1}.

  3. Select the datetime unit that will be used to perform mathematical operations in the included macro(s) from the Time Unit for Operations pulldown menu—for example, for the macro {now-1}, when Day is selected, {now-1} will be converted to the datetime one day before the current datetime.

Lookup-Based Macros (API URL)​

Optional

Column values from existing lookups can also be included as macros in the API URL. Lookup-based macros allow you to reference data from previously configured data sources or lookups, enabling dynamic API endpoints that can adapt based on existing data.

Lookup-based macros are useful when you need to create API endpoints that reference specific IDs, values, or parameters from other data sources in your Nexla environment.

  1. To include a lookup column value macro, select the relevant lookup from the Add Lookups to Supported Macros pulldown menu.

  2. Type { at the appropriate position in the API URL, and select the lookup column-based macro from the dropdown list. Lookup-based macros are automatically populated into the macro list when a lookup is selected in the Add Lookups to Supported Macros pulldown menu.

Path to Data​

Optional

If only a subset of the data that will be returned by API endpoint is needed, you can designate the part(s) of the response that should be included in the Nexset(s) produced from this source by specifying the path to the relevant data within the response. This is particularly useful when API responses contain metadata, pagination information, or other data that you don't need for your analysis.

For example, when a request call is used to fetch a list of items, the API will typically return an array of records, along with metadata, in the response. By entering the path to the relevant data, you can configure Nexla to treat each element of the returned array as a record.

Path to Data is essential when API responses have nested structures. Without specifying the correct path, Nexla might not be able to properly parse and organize your data into usable records.

  • To specify which data should be treated as relevant in responses from this source, enter the path to the relevant data in the Set Path to Data in Response field.

    • For responses in JSON format enter the JSON path that points to the object or array that should be treated as relevant data. JSON paths use dot notation (e.g., $.data.items[*] to access an array of items within a data object).

    • For responses in XML format, enter the XPath that points to the object/array containing relevant data. XPath uses slash notation (e.g., /response/data/item to access item elements within a data element).

    Path to Data Example:

    If the API response is in JSON format and includes a top-level array named data that contains the relevant data, the path to the response would be entered as $.data[*].

Autogenerate Path Suggestions​

Nexla can also autogenerate data path suggestions based on the response from the API endpoint. These suggested paths can be used as-is or modified to exactly suit your needs.

  • To use this feature, click the Test button next to the Set API URL field to fetch a sample response from the API endpoint. Suggested data paths generated based on the content & format of the response will be displayed in the Suggestions box below the Set Path to Data in Response field.

  • Click on a suggestion to automatically populate the Set Path to Data in Response field with the corresponding path. The populated path can be modified directly within the field if further customization is needed.

    PathSuggestions.png

Metadata​

If metadata is included in the response but is located outside of the defined path to relevant data, you can configure Nexla to include this data as common metadata in each record. This is useful when you want to preserve important contextual information that applies to all records but isn't part of the main data array.

For example, when a request call is used to fetch a list of items, the API response will typically include an array of records along with metadata such as total count, pagination information, or request timestamps. In this case, if you have specified the path to the relevant data but metadata of interest is located in a different part of the response, you can specify a path to this metadata to include it with each record in the generated Nexset(s).

Metadata paths are particularly useful for preserving API response context like request IDs, timestamps, or summary statistics that apply to all records in the response.

  • To specify the location of metadata that should be included with each record, enter the path to the relevant metadata in the Path to Metadata in Response field.

    • For responses in JSON format, enter the JSON path to the object or array that contains the metadata, and for responses in XML format, enter the XPath.

Request Headers​

Optional

  • If Nexla should include any additional request headers in API calls to this source, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2). Additional headers are often required for API versioning, content type specifications, or custom authentication requirements.

    You do not need to include any headers already present in the credentials. Common headers like Authorization, Content-Type, and Accept are typically handled automatically by Nexla based on your credential configuration.

Endpoint Testing​

After configuring all settings for the selected endpoint, Nexla can retrieve a sample of the data that will be fetched according to the current configuration. 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.

Save & Activate the Source​

  1. Once all of the relevant steps in the above sections have been completed, click the Create button in the upper right corner of the screen to save and create the new Avoma data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.