Skip to main content

Data Source

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

Namely

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

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

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

    This endpoint template retrieves all resources of a specified type from your Namely account. Use this template when you need to fetch all records of a specific resource type, such as all groups, teams, events, job titles, or profiles. The endpoint returns an array of all resources of the specified type.

    • Select or type the resource type in the Resource Type field. Available options include groups (returns an array of all groups), teams (returns an array of all teams as well as linked team categories), events (returns all events, paginated, with linked profiles that commented on events), job_titles (returns all job titles), and profiles (returns all active and inactive employee profiles). You can also type a custom resource type if needed. The resource type determines which Namely resources will be retrieved.

    This endpoint retrieves all resources of the specified type from your Namely account. The endpoint returns an array of resources, with the array key matching the resource type (e.g., groups, teams, profiles). Some resource types may return paginated results, which Nexla will handle automatically.

    Common resource types include groups, teams, events, job_titles, and profiles. For detailed information about available resource types, API response structures, and resource data formats, see the Namely API documentation.

    Get A Resource

    This endpoint template retrieves a specific resource by resource ID from your Namely account. Use this template when you need to fetch detailed information about a specific resource, such as a specific profile, event, group, team, job tier, or report.

    • Select or type the resource type in the Resource Type field. Available options include profiles (user profile), job_tiers (job tiers), events (events), groups (groups), teams (teams), and reports (reports). You can also type a custom resource type if needed. The resource type determines which type of Namely resource will be retrieved.
    • Enter the resource ID in the Resource ID field. This is the unique identifier of the resource you want to fetch details for. The resource ID is typically a numeric or alphanumeric identifier that uniquely identifies the resource within the specified resource type.

    This endpoint retrieves a specific resource by its ID from your Namely account. The endpoint returns detailed information about the specified resource, including all associated data and relationships. The resource ID must be valid for the specified resource type.

    Common resource types include profiles, job_tiers, events, groups, teams, and reports. For detailed information about available resource types, resource IDs, API response structures, and resource data formats, see the Namely 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​

Namely data sources can be manually configured to ingest data from any valid Namely 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 Namely sources, such as sources that use chained API calls to fetch related resource 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 Namely API from the Method pulldown menu. Namely API typically uses GET method for retrieving data from endpoints.

API Endpoint URL​

  1. Enter the URL of the Namely API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL including your company name (from your credential), the API path (e.g., /api/v1/profiles), and any required query parameters (e.g., https://acme.namely.com/api/v1/profiles). Include any required query parameters in the URL.

Ensure the API endpoint URL is correct and accessible with your current credentials. The Namely API endpoint URL should point to a valid resource endpoint. 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 Namely API responses, use $.{resource_type}[*] to extract all items from the resource array in the response, where {resource_type} is the resource type (e.g., $.profiles[*] for profiles).

The JSONPath expression must correctly reference the structure of your Namely API response. Namely API responses typically have a property matching the resource type containing an array of resource objects. 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.

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.