Skip to main content

Hub Planner Destination

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow data flow that sends data to a Hub Planner location.
hubplanner_api.png

Hub Planner

  1. Click the + icon on the Nexset that will be sent to the Hub Planner destination, and select the Send to Destination option from the menu.

  2. Select the Hub Planner connector from the list of available destination connectors. Then, select the credential that will be used to connect to the Hub Planner organization, and click Next; or, create a new Hub Planner credential for use in this flow.

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

    Hub Planner destinations can also be configured manually, allowing you to send data to Hub Planner endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this destination manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Hub Planner endpoints. Each template is designed specifically for the corresponding Hub Planner endpoint, making destination setup easy and efficient.

Endpoint Settings​

  • Select the endpoint to which this destination will send 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 destination for this endpoint.

    Create Project

    Creates a new project in Hub Planner. Use this endpoint to programmatically provision projects from external systems such as CRMs or project intake workflows.

    • Sends a POST request to https://api.hubplanner.com/v1/project with a JSON payload describing the new project.
    • No path parameters are required for project creation; all project fields are provided in the request body.

    Hub Planner enforces a daily API rate limit of 6,000 calls and a burst limit of 50 requests per 5 seconds. For high-volume project creation, consider enabling record batching to reduce individual API calls.

    Update Project

    Updates an existing project in Hub Planner. Use this endpoint to sync project status, metadata, or custom fields from external systems back into Hub Planner.

    • Sends a PUT or PATCH request to https://api.hubplanner.com/v1/project/{'{id}'} with a JSON payload containing the fields to update.
    • Configure the following parameters: Project ID — the alphanumeric ID of the Hub Planner project to update. This value must be included in the API URL path.

    Hub Planner project IDs are alphanumeric strings. Ensure the correct project ID format is used when constructing the destination URL for update operations.

    Delete Project

    Deletes an existing project in Hub Planner. Use this endpoint to programmatically remove projects as part of automated archival or cleanup workflows.

    • Sends a DELETE request to https://api.hubplanner.com/v1/project/{'{id}'}. No request body is required.
    • Configure the following parameters: Project ID — the alphanumeric ID of the Hub Planner project to delete. This value must be included in the API URL path.

    Project deletion in Hub Planner is permanent and cannot be undone. Verify the correct project IDs before activating a delete destination to avoid accidental data loss.

    Create Resource

    Creates a new resource (team member) in Hub Planner. Use this endpoint to onboard new employees or contractors into Hub Planner from HR or identity management systems.

    • Sends a POST request to https://api.hubplanner.com/v1/resource with a JSON payload describing the new resource.
    • No path parameters are required for resource creation; all resource fields (e.g., name, email, role) are provided in the request body.

    Newly created resources must be assigned to projects or groups within Hub Planner before they can be included in booking and scheduling operations.

    Update Resource

    Updates an existing resource (team member) in Hub Planner. Use this endpoint to keep resource profiles synchronized with HR systems or directory services.

    • Sends a PUT or PATCH request to https://api.hubplanner.com/v1/resource/{'{id}'} with a JSON payload containing the fields to update.
    • Configure the following parameters: Resource ID — the alphanumeric ID of the Hub Planner resource to update. This value must be included in the API URL path.

    Hub Planner resource IDs are alphanumeric strings. Ensure the correct resource ID format is used when constructing the destination URL for update operations.

    Create Booking

    Creates a new booking (resource allocation) in Hub Planner. Use this endpoint to programmatically schedule team members to projects from external planning or ticketing systems.

    • Sends a POST request to https://api.hubplanner.com/v1/booking with a JSON payload describing the new booking, including resource ID, project ID, start date, end date, and allocation details.
    • No path parameters are required for booking creation; all booking fields are provided in the request body.

    Bookings require valid resource IDs and project IDs. Ensure these values are correctly mapped from your Nexset data before activating the destination to avoid validation errors from the Hub Planner API.

Endpoint Testing​

Once the selected endpoint template has been configured, Nexla can send a test payload to the Hub Planner API to ensure that the destination is configured correctly.

  • 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 destinations can also be manually configured to send data to any valid Hub Planner API endpoint. You can also configure Nexla to automatically send the response received from the Hub Planner API after each call to a new Nexla webhook data source.

First, select the API method that will be used for calls to the Hub Planner API from the Method pulldown menu. Common methods for Hub Planner write operations include:

  • POST: For creating new records — e.g., creating a new booking, time entry, project, resource, or event
  • PUT: For updating an existing record in full — e.g., updating a project or resource by its ID
  • PATCH: For partial updates to an existing record — use when updating only specific fields
  • DELETE: For removing an existing record by its ID

Data Format​

  1. Select the format in which the Nexset data will be sent to the Hub Planner API from the Content Format pulldown menu. Nexla will automatically convert the data to the selected format for each API call.

    Hub Planner accepts and returns JSON for all API requests. Select JSON as the content format to ensure compatibility with the Hub Planner API.

API Endpoint URL​

  1. Enter the URL of the Hub Planner API endpoint to which you want to send the Nexset data in the URL field. Hub Planner API endpoints follow the base URL pattern https://api.hubplanner.com/v1/. Common destination endpoints include:

    • https://api.hubplanner.com/v1/booking — Create a new booking/allocation (POST)
    • https://api.hubplanner.com/v1/booking/{'{id}'} — Update an existing booking (PUT/PATCH)
    • https://api.hubplanner.com/v1/timeentry — Create a new time entry (POST)
    • https://api.hubplanner.com/v1/timeentry/{'{id}'} — Update an existing time entry (PUT/PATCH)
    • https://api.hubplanner.com/v1/project — Create a new project (POST)
    • https://api.hubplanner.com/v1/project/{'{id}'} — Update an existing project (PUT/PATCH)
    • https://api.hubplanner.com/v1/resource — Create a new resource (POST)
    • https://api.hubplanner.com/v1/resource/{'{id}'} — Update an existing resource (PUT/PATCH)
    • https://api.hubplanner.com/v1/event — Create a new event (POST)
    • https://api.hubplanner.com/v1/milestone — Create a new milestone (POST)

    For update and delete operations, append the ID of the record to be modified to the end of the URL (e.g., https://api.hubplanner.com/v1/booking/64a1b2c3d4e5f6789).

All Hub Planner API requests must use HTTPS. Hub Planner resource IDs are alphanumeric strings — ensure the correct ID format is used when constructing update or delete URLs. Hub Planner enforces a daily API rate limit of 6,000 API calls and a burst limit of 50 requests per 5 seconds. For high-volume destinations, consider using record batching to reduce the number of individual API calls.

Request Headers​

Optional

  • If Nexla should include any additional request headers in API calls to this destination, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2).

    You do not need to include the Authorization header or Content-Type/Accept headers — these are already handled automatically by Nexla based on your Hub Planner credential configuration.

Exclude Attributes from the Call​

Optional

  • If any record attributes in the Nexset should be omitted when sending data to this Hub Planner destination, select the attributes from the Exclude Attributes pulldown menu.

  • Any number of attributes can be selected for exclusion, and all excluded attributes will be shown in the field. To remove an attribute from the list, click the X icon next to the attribute name.

Record Batching​

Optional

  1. If records should be sent to this destination in batched API calls, check the box next to Would you like to batch your records together? to enable record batching.

  2. Enter the maximum number of records that should be batched together in a single API call in the Batch Size field. By default, this value is set to 100.

  3. Select the algorithm that will be used to group records into batches from the Grouping Algorithm pulldown menu. The sample request shown in the panel on the right will be updated to reflect the current batching settings. Some algorithms require additional settings — click on an algorithm listed below to view instructions for configuring these settings.

Property Inside JSON Object

  1. Enter the name of the JSON property that should contain the batched records in the Property Name field.
  2. If any additional properties should be included in the request, enter the properties in the Other Props field in JSON format.

Code

  1. Enter the code that will be used to create the batched request in the code editor below the Grouping Algorithm field.

Response Webhook​

Optional

Nexla can automatically send the response received from the Hub Planner API after each call to a new Nexla webhook data source. This option allows you to keep track of the status of each API call and any additional information returned after each call — for example, to capture the IDs of newly created bookings or time entries returned by Hub Planner in response to a POST request.

  • To enable this option, check the box next to Would you like to process the API response as a Nexla Webhook source?.

Sample Request Payload​

Sample request payloads containing a portion of the Nexset data that will be sent to the Hub Planner API endpoint based on the current settings are shown in the Sample Payload panel on the right. These samples can be referenced to ensure that the destination and request settings are correctly configured.

  • Click on a sample request payload to expand it and view the complete payload content.
  • Sample payloads are automatically updated with each setting change, making it easy to verify that changes achieve the desired effect.

Endpoint Testing​

After all endpoint settings have been configured, Nexla can send a test payload to the Hub Planner API to ensure that the destination is configured correctly.

  1. To send a test payload, select the Test button at the top of the Sample Payload panel, and click on a listed sample payload to expand it.

  2. If any modifications to the sample payload are needed, make the necessary changes directly within the sample window.

  3. Click the Send Test Data button at the top of a sample payload to send the test payload to the Hub Planner API using the current settings.

Save & Activate the Destination​

  • 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 Hub Planner endpoint, open the destination resource menu, and select Activate.

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