Namely

Namely is a cloud-based HR technology platform specifically designed for small and mid-sized companies, providing comprehensive human resources management, employee engagement tools, payroll processing, and benefits administration to streamline HR operations and enhance employee experience.

Power end-to-end data operations for your Namely API with Nexla. Our bi-directional Namely connector is purpose-built for Namely, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Namely or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Namely workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

• Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
• Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
• API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
• Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites

Before creating a Namely credential, you need to obtain your Personal Access Token (PAT) and company name from your Namely account. Namely uses Personal Access Token authentication for all API requests, with the PAT sent in the Authorization header with the Bearer prefix.

To obtain your Namely API credentials, follow these steps:

1. Sign in to your Namely account using your administrator credentials.

2. Navigate to your account settings or profile settings in the Namely interface.

3. Look for the API or Personal Access Tokens section in your account settings.

4. If you don't have a Personal Access Token yet, click Generate Token or Create Personal Access Token to create a new PAT.

5. Configure your Personal Access Token settings:

   • Enter a name or description for the token (e.g., "Nexla Integration")
   • Set the expiration time (PATs have a longer expiration time of 2 years by default)
   • Review and select the permissions or scopes for the token

6. Click Generate or Create to create the Personal Access Token.

7. Copy the Personal Access Token immediately after it's generated, as it may not be accessible again after you navigate away from the page.

8. Identify your company name. This is the subdomain used in your Namely URL. For example, if your Namely URL is https://acme.namely.com, your company name is acme. You can find this in your Namely URL or in your account settings.

9. Store both the Personal Access Token and company name securely, as you will need them to configure your Nexla credential. The Personal Access Token is sensitive information and should be kept confidential.

The Personal Access Token is sent in the Authorization header with the Bearer prefix (e.g., Authorization: Bearer {pat}) for all API requests to the Namely API. The company name is used to construct API endpoint URLs specific to your Namely instance (e.g., https://{company}.namely.com/api/v1/profiles/me). The PAT authenticates your requests and grants access to Namely resources based on your account permissions and the token's scopes. If your Personal Access Token is compromised, you should immediately revoke it in your Namely account settings and generate a new one. For detailed information about Personal Access Tokens, API authentication, and available endpoints, refer to the Namely API documentation.

Authenticate

Credentials required

Field	Required	Secret	Description
Personal Access Token	Yes	Yes	PATs are easier to create and use than OAuth applications and have a longer expiration time of 2 years.
Company Name	Yes	No	Name of the company that the user had configured.

Create a credential in Nexla

1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

New Credential Overlay – Namely

2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

3. Enter your Namely Personal Access Token in the Personal Access Token field. This is the PAT you obtained from your Namely account settings (API or Personal Access Tokens section). The Personal Access Token is sent in the Authorization: Bearer {pat} header for all API requests to the Namely API. The Personal Access Token is sensitive information and must be kept confidential.

4. Enter your Namely company name in the Company Name field. This is the subdomain used in your Namely URL. For example, if your Namely URL is https://acme.namely.com, your company name is acme. The company name is used to construct API endpoint URLs specific to your Namely instance (e.g., https://{company}.namely.com/api/v1/profiles/me). You can find this in your Namely URL or in your account settings.

   Your Namely Personal Access Token can be found in your Namely account settings under the API or Personal Access Tokens section. Personal Access Tokens are easier to create and use than OAuth applications and have a longer expiration time of 2 years. The Personal Access Token is sent in the Authorization: Bearer {pat} header for all API requests to the Namely API.

   Your company name is the subdomain used in your Namely URL. For example, if your Namely URL is https://acme.namely.com, your company name is acme. The company name is used to construct API endpoint URLs specific to your Namely instance.

   If your Personal Access Token is compromised, you should immediately revoke it in your Namely account settings and generate a new one. The Personal Access Token provides access to your Namely account data and should be treated as sensitive information. Keep your Personal Access Token secure and do not share it publicly.

   For detailed information about Personal Access Tokens, API authentication, and available endpoints, see the Namely API documentation.

5. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Use as a data source

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Namely connector tile, 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.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Namely endpoints. 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.

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.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration

Namely data sources can also be manually configured to ingest data from any valid Namely API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom query parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

Namely API endpoints typically use the GET method and follow the pattern https://{company}.namely.com/api/v1/{path} (e.g., https://acme.namely.com/api/v1/profiles). For the Response Data Path, use $.{resource_type}[*] to extract all items from the resource array in the response, where {resource_type} is the requested resource type (e.g., $.profiles[*] for profiles).

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new Namely 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.

Use as a destination

Click the + icon on the Nexset that will be sent to the Namely destination, and select the Send to Destination option from the menu. Select the Namely connector from the list of available destination 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.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Namely endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

Create A Resource

This endpoint template creates a new resource in your Namely account. Use this template when you need to create new resources such as announcements, events, profiles, or other Namely resources. The endpoint sends data as JSON in the request body to create the new resource.

• Enter the resource type in the Resource Type field. This should be the resource type you want to create (e.g., announcements, events, profiles). The resource type determines which type of Namely resource will be created. Refer to the Namely API documentation for available resource types and their required fields.

This endpoint sends data as JSON in the request body to create a new resource in your Namely account. The request body should contain the resource data in JSON format, with field names matching the Namely API's expected structure for the specified resource type. The endpoint returns the created resource with its assigned ID and other generated fields.

For detailed information about creating resources, available resource types, required fields, and request body formats, see the Namely API documentation.

Update A Resource

This endpoint template updates an existing resource in your Namely account by resource ID. Use this template when you need to update existing resources such as profiles, events, or other Namely resources. The endpoint sends data as JSON in the request body to update the specified resource.

• Enter the resource type in the Resource Type field. This should be the resource type you want to update (e.g., profiles, events, groups). The resource type determines which type of Namely resource will be updated. Refer to the Namely API documentation for available resource types and their updatable fields.
• Enter the resource ID in the Resource ID field. This is the unique identifier of the resource you want to update. The resource ID is typically a numeric or alphanumeric identifier that uniquely identifies the resource within the specified resource type.

This endpoint sends data as JSON in the request body to update an existing resource in your Namely account. The request body should contain the resource data in JSON format, with field names matching the Namely API's expected structure for the specified resource type. Only fields included in the request body will be updated; other fields will remain unchanged.

For detailed information about updating resources, available resource types, updatable fields, and request body formats, see the Namely API documentation.

Manual configuration

Namely destinations can also be manually configured to send data to any valid Namely API endpoint. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.

Namely API destinations typically use the POST method for creating resources, PUT for updating resources, and PATCH for partial updates, with JSON content format. Endpoint URLs follow the pattern https://{company}.namely.com/api/v1/{path} (e.g., https://acme.namely.com/api/v1/profiles), and update operations include the resource ID in the URL path (e.g., https://acme.namely.com/api/v1/profiles/{resource_id}). The request body is typically formatted as {message.json} to send the entire Nexset record as JSON, with field names matching the Namely API's expected structure for the specified resource type.

Save & activate

Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured Namely endpoint, open the destination resource menu, and select Activate.

The Nexset data will not be sent to the Namely endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.