Skip to main content

Hub Planner Data Source

The Hub Planner connector enables you to ingest resource scheduling, project planning, booking, and timesheet data from your Hub Planner account into Nexla data flows. This is particularly useful for analytics pipelines, capacity reporting, workforce dashboards, and cross-system integrations that need access to Hub Planner's resources, projects, bookings, timesheets, clients, groups, milestones, and billing rate data. Follow the instructions below to create a new data flow that ingests data from a Hub Planner source in Nexla.
hubplanner_api.png

Hub Planner

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

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

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

    Returns a list of all billing rates configured in the Hub Planner account. Use this endpoint to extract billing rate data for financial reporting or cost analysis.

    • Sends a GET request to https://api.hubplanner.com/v1/billingRate and returns all billing rate records.
    • Response data is returned as a top-level JSON array; each element represents a single billing rate record. The data path is $[*].

    Hub Planner enforces a daily API rate limit of 6,000 calls and a burst limit of 50 requests per 5 seconds. For accounts with many billing rates, consider scheduling runs during off-peak hours.

    List Bookings

    Returns a list of all bookings (resource allocations) in the Hub Planner account. Use this endpoint to retrieve scheduling and capacity data across projects and team members.

    • Sends a GET request to https://api.hubplanner.com/v1/booking and returns all booking records.
    • Response data is returned as a top-level JSON array; each element represents a single booking. The data path is $[*]. Booking endpoints support pagination via page and limit query parameters (max 1,000 per page).

    For accounts with large numbers of bookings, use pagination parameters in the API URL (e.g., ?page=0&limit=1000) and configure Nexla to loop through pages for complete data retrieval.

    List Clients

    Returns a list of all clients in the Hub Planner account. Use this endpoint to sync client records with CRM systems or build client-level reporting.

    • Sends a GET request to https://api.hubplanner.com/v1/client and returns all client records.
    • Response data is returned as a top-level JSON array; each element represents a single client record. The data path is $[*].

    Hub Planner API requests require HTTPS. Nexla handles the required Content-Type: application/json and Accept: application/json headers automatically based on the credential configuration.

    List Events

    Returns a list of all events in the Hub Planner account. Use this endpoint to track scheduled events alongside bookings and project milestones.

    • Sends a GET request to https://api.hubplanner.com/v1/event and returns all event records.
    • Response data is returned as a top-level JSON array; each element represents a single event. The data path is $[*].

    Hub Planner resource IDs are alphanumeric strings. Ensure downstream systems that join event data with other Hub Planner resources handle string-type IDs correctly.

    List Holidays

    Returns a list of all holidays configured in the Hub Planner account. Use this endpoint to align capacity planning and scheduling data with non-working days.

    • Sends a GET request to https://api.hubplanner.com/v1/holiday and returns all holiday records.
    • Response data is returned as a top-level JSON array; each element represents a single holiday entry. The data path is $[*].

    Holiday calendars in Hub Planner can be region-specific. Review the returned records to confirm the correct holiday set is being retrieved for your reporting needs.

    List Projects

    Returns a list of all projects in the Hub Planner account. Use this endpoint to build project-level dashboards, track project status, or sync projects with external project management tools.

    • Sends a GET request to https://api.hubplanner.com/v1/project and returns all project records.
    • Response data is returned as a top-level JSON array; each element represents a single project. The data path is $[*].

    Hub Planner returns all results for Project endpoints without requiring pagination. For very large accounts, monitor response size and use filtering query parameters if supported by your Hub Planner plan.

    List Resources

    Returns a list of all resources (team members) in the Hub Planner account. Use this endpoint to sync resource data with HR systems, build workforce capacity reports, or populate lookups for other Hub Planner data flows.

    • Sends a GET request to https://api.hubplanner.com/v1/resource and returns all resource records.
    • Response data is returned as a top-level JSON array; each element represents a single resource (team member). The data path is $[*].

    Hub Planner returns all results for Resource endpoints without requiring pagination. Resource records include fields such as name, email, role, and availability settings that are useful for downstream workforce analytics.

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​

Hub Planner sources can also be configured manually, allowing you to ingest data from Hub Planner endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.

First, select the method that will be used for calls to the Hub Planner API from the Method pulldown menu. The most common methods are:

  • GET: For retrieving data from the API (most Hub Planner read operations use GET)
  • POST: For sending data to the API or triggering search/filter operations (Hub Planner supports POST /areaName/search for filtered queries)

API Endpoint URL​

  1. Enter the URL of the Hub Planner 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.

    Hub Planner API endpoints follow the base URL pattern https://api.hubplanner.com/v1/. Common endpoints include:

    • https://api.hubplanner.com/v1/resource — Retrieve all resources (team members)
    • https://api.hubplanner.com/v1/project — Retrieve all projects
    • https://api.hubplanner.com/v1/booking — Retrieve bookings/allocations
    • https://api.hubplanner.com/v1/timeentry — Retrieve timesheet time entries
    • https://api.hubplanner.com/v1/client — Retrieve clients
    • https://api.hubplanner.com/v1/group — Retrieve resource groups
    • https://api.hubplanner.com/v1/milestone — Retrieve project milestones
    • https://api.hubplanner.com/v1/event — Retrieve events
    • https://api.hubplanner.com/v1/publicholiday — Retrieve public holidays
    • https://api.hubplanner.com/v1/billingrate — Retrieve billing rates

All Hub Planner API requests must be made over HTTPS. The Content-Type and Accept headers must be set to application/json for all requests — Nexla handles these headers automatically based on the Hub Planner connector configuration.

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 for Hub Planner endpoints that support date range filtering. For example, Hub Planner's booking and time entry endpoints accept startDate and endDate query parameters, enabling you to retrieve data for specific periods without manually updating the URL for each run.

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

    Hub Planner API date fields use the YYYY-MM-DD format (e.g., 2025-01-15). Select the matching date format when configuring datetime macros to ensure compatibility with Hub Planner's query parameters.

  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 for Hub Planner integrations where you need to dynamically reference specific resource IDs, project IDs, or other identifiers from other data sources in your Nexla environment — for example, building a URL that fetches bookings for a specific project ID retrieved from another source.

  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.

Pagination Settings​

Optional

Hub Planner supports pagination on most endpoints using the page and limit query parameters. By default, Hub Planner returns all results for Project and Resource endpoints, while Booking and Time Entry endpoints return 20 results per page when no limit is specified. Pages are zero-indexed (starting at page=0).

To configure pagination in the API URL, append the pagination parameters directly:

  • https://api.hubplanner.com/v1/booking?page=0&limit=200 — Retrieve bookings with 200 results per page

The maximum page limit for Hub Planner API is 1,000 records per page. Passing a limit greater than 1,000 or a limit of 0 (for paginated endpoints) will return a 400 Bad Request error. For large datasets, configure Nexla to loop through pages by referencing the Hub Planner pagination parameters in the API URL.

Path to Data​

Optional

If only a subset of the data returned by the 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 Hub Planner API will typically return an array of records 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).

    • Hub Planner typically returns arrays of objects directly at the top level of the response — for example, a GET request to /resource returns a JSON array of resource objects. In this case, enter $[*] to treat each array element as a separate record.

    Path to Data Example:

    If the Hub Planner API response is a top-level JSON array of resource records, the path to the data would be entered as $[*]. If the response wraps results inside a property such as data, the path would be $.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 Hub Planner bookings, the API response may include pagination metadata alongside the records array. If you have specified the path to the relevant booking data but want to preserve pagination metadata, you can specify a path to this metadata to include it with each record.

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 sometimes required for API versioning, content type specifications, or custom authentication requirements.

    You do not need to include the Authorization header or Content-Type/Accept headers in this field — these are already handled automatically by Nexla based on your Hub Planner 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 Hub Planner 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.