Height Data Source

The Height connector enables you to ingest project management data — including tasks, lists, activities, users, and field template definitions — from your Height workspace into Nexla data flows. This is particularly useful for analytics pipelines, project reporting dashboards, cross-system integrations, and audit workflows that need access to Height workspace data. Follow the instructions below to create a new data flow that ingests data from a Height source in Nexla.

Height

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

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

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

Retrieves the current workspace information, including the workspace name, ID, URL slug, and configuration details. Use this endpoint to obtain workspace-level metadata or to verify that your credential is connected to the correct Height workspace.

• This endpoint requires no additional configuration beyond selecting the template. Nexla will automatically retrieve the workspace record associated with the authenticated API key.
• The response includes the workspace ID, name, URL handle, and other workspace-level configuration data.

The workspace ID returned by this endpoint can be useful as a reference when building multi-step API calls or when joining Height data with records from other systems.

List Lists

Retrieves all lists shared with the entire workspace. In Height, lists are containers that organize tasks — similar to projects or boards in other tools. Use this endpoint to obtain list IDs and names, which are required when creating tasks or filtering task queries by list.

• This endpoint requires no additional configuration. Nexla will automatically retrieve all workspace-level lists accessible to the authenticated user.
• The response includes each list's unique ID, name, description, color, appearance, and other configuration attributes.
• Only lists shared with the entire workspace are returned. Private or restricted lists may not appear in the results depending on the authenticated user's permissions.

List IDs are required when using the Create Task or Search Tasks endpoints. Run this endpoint first to discover available list IDs if you intend to use them in other Height API calls.

Search Tasks

Searches for tasks within your Height workspace using a text query. Use this endpoint to retrieve tasks matching specific keywords, titles, or descriptions. This is particularly useful for building targeted data pipelines that pull only the tasks relevant to a specific project, team, or status.

• Enter your search query in the Query field. The query is matched against task titles and descriptions. For example:

  • Enter a keyword such as bug or release to find all tasks containing that term.
  • Enter a specific task title or partial title to locate a particular task.
  • Leave the query empty to retrieve all tasks in the workspace (subject to pagination limits).
• The response includes matching task records with their IDs, titles, descriptions, assignees, statuses, list assignments, due dates, and custom field values.

Height's search is performed across task titles and descriptions. For more targeted filtering (e.g., by status, assignee, or list), consider using the manual configuration option to construct a custom API request with specific query parameters.

List Users

Retrieves all users (workspace members) in your Height workspace. Use this endpoint to obtain user IDs, names, and email addresses for reporting, auditing, or cross-referencing with task assignee data.

• This endpoint requires no additional configuration. Nexla will automatically retrieve all user records from the workspace.
• The response includes each user's unique ID, display name, email address, and workspace role.
• User IDs returned by this endpoint correspond to the assignee and follower fields in task records, enabling joins between user and task data.

Use the user IDs from this endpoint to enrich task data with user details, such as mapping assignee IDs to names and email addresses for reporting dashboards or notifications.

List Field Templates

Retrieves all field templates defined in the workspace. Field templates define custom attributes that can be attached to tasks — such as priority levels, status options, labels, and numeric fields. Use this endpoint to discover available custom fields and their allowed values before creating or updating tasks with custom attribute data.

• This endpoint requires no additional configuration. Nexla will automatically retrieve all field template definitions from the workspace.
• The response includes each field template's unique ID, name, data type (e.g., select, multi-select, number, text, date), and the list of allowed values where applicable.
• Field template IDs and their allowed value IDs are required when creating tasks that include custom attribute values.

Running this endpoint is recommended before building task creation or update workflows, as it provides the full list of available custom fields and their valid values — ensuring that any custom attribute data you send to Height uses the correct IDs and formats.

List Activities

Retrieves activity records from your Height workspace. Activities represent events associated with tasks, including messages posted in task threads, status changes, assignment updates, and integration-related events (such as GitHub commits or pull request links). Use this endpoint to ingest collaboration history, audit task activity, or build activity feed integrations.

• Optionally, provide a Task ID to retrieve activities for a specific task. If no Task ID is provided, Nexla will retrieve activities across all tasks in the workspace.

  • Task IDs can be obtained by first running the Search Tasks endpoint.
• The response includes the activity type, the user who performed the action, the timestamp, and any associated content (e.g., message text or field change details).
• Activity types include: message (comments in task threads), createdTask, statusChange, assigneeChange, dueDateChange, and integration events such as GitHub PR links.

The Height API enforces a stricter rate limit of 60 requests per minute for activity-related endpoints. If your flow is retrieving activities for a large number of tasks, consider using Nexla's scheduling settings to pace the requests appropriately.

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

Height data sources can be manually configured to ingest data from any valid Height 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 Height sources, such as sources that use chained API calls to fetch data from multiple endpoints or sources that require custom 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 Height API from the Method pulldown menu. The most common methods are:

   • GET: For retrieving data from the API — used for all Height read endpoints (tasks, lists, users, workspace, field templates, activities)
   • POST: For sending data to the API or triggering search operations — used for the Height search endpoint (POST /tasks/search)

API Endpoint URL

3. Enter the URL of the Height API endpoint from which this source will fetch data in the Set API URL field. Height API endpoints use the base URL https://api.height.app. Some commonly used endpoints include:

   • https://api.height.app/workspace — Retrieve workspace information
   • https://api.height.app/lists — Retrieve all workspace lists
   • https://api.height.app/tasks — Retrieve tasks (supports query parameters)
   • https://api.height.app/users — Retrieve all workspace users
   • https://api.height.app/fieldTemplates — Retrieve all custom field template definitions
   • https://api.height.app/activities — Retrieve workspace activities

All Height API requests must use HTTPS. The API enforces a rate limit of 120 requests per minute on most endpoints, and 60 requests per minute for activity and task creation endpoints. If your Nexla flow generates frequent API calls, use Nexla's scheduling settings to pace requests within these limits.

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.

Date/time macros are particularly useful when filtering Height API results by date ranges, such as retrieving activities or tasks updated after a specific date using query parameters like updatedAt[gt] or createdAt[lt].

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 in Height workflows where you need to pass task IDs, list IDs, or user IDs from one API call into the URL of a subsequent call — for example, passing a list ID retrieved from the Lists endpoint into a task query URL.

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 the Height 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 Height API responses contain metadata or wrapper objects surrounding the actual data records.

For example, most Height API list endpoints return a JSON object with a list property containing the array of records. By specifying $.list[*] as the path to data, you can configure Nexla to treat each element of the returned array as a separate record.

Path to Data is essential for Height API responses, as most endpoints wrap their results in a top-level object. Without specifying the correct path, Nexla may not be able to properly parse and organize the 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., $.list[*] to access an array of items within a list property).
  Path to Data Example:

  For the Height GET /lists endpoint, the response JSON includes a top-level list property that contains the array of list records. Enter $.list[*] as the path to data to treat each list record as a separate row in the resulting Nexset.

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.

  

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 is not part of the main data array.

For example, Height API responses often include pagination metadata such as total record counts alongside the data array. If you have specified the path to the relevant records but want to preserve the total count or other response-level metadata, you can specify a path to this metadata to include it with each record.

Metadata paths are particularly useful for preserving Height API response context, such as total task counts or pagination information, that applies 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.

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 may be needed for API versioning or custom content type specifications.

  You do not need to include the Authorization header here — it is automatically applied by Nexla based on your Height credential configuration. Common headers like Authorization and Content-Type are handled automatically.

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 Height 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.