Skip to main content

Baton Data Source

Baton is a project management platform built for software implementation and customer onboarding. The Baton connector enables you to ingest project, task, milestone, team, and time tracking data from your Baton account into Nexla for reporting, analysis, and integration with downstream systems. Follow the instructions below to create a new data flow that ingests data from a Baton source in Nexla.
hellobaton_api.png

Baton

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

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

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

Retrieves all implementation projects within your Baton organization. Use this endpoint to ingest project records including project names, statuses, due dates, associated companies, and assigned team members for reporting, pipeline analysis, or synchronization with other business tools.

  • This endpoint returns all projects accessible to your Baton credential. No additional configuration is required beyond selecting this template.
  • Each project record includes metadata such as project ID, name, status, start and due dates, associated client company, and assigned project manager.
  • The connector performs a full refresh each time it syncs, retrieving all available project records from your Baton account.

The Baton API is rate limited at 1,000 requests per minute per API key. For large organizations with many projects, Nexla will automatically manage pagination to retrieve all records within this limit.

Get Tasks

Retrieves all tasks across projects in your Baton organization. Tasks are the individual work items assigned to team members or clients within a project. Use this endpoint to track task progress, assignments, dependencies, and completion status across all your implementation projects.

  • This endpoint returns all tasks accessible to your Baton credential, including task names, descriptions, assignees, due dates, statuses, and any task dependencies.
  • Task records include references to their parent project, allowing you to join task data with project records retrieved from the Get Projects endpoint.
  • The connector performs a full refresh each sync, retrieving all available task records.

Task dependencies are included in the response and indicate which tasks must be completed before others can begin. This data is particularly useful for building dependency graphs or identifying bottlenecks in your implementation workflows.

Get Milestones

Retrieves all milestones defined within your Baton projects. Milestones represent key checkpoints or deliverables in an implementation project. Use this endpoint to track milestone completion rates, identify delays, and report on project progress against key delivery targets.

  • This endpoint returns all milestones across all projects, including milestone names, associated project IDs, target dates, completion dates, and statuses.
  • Milestone records can be joined with project records using the project ID field to build comprehensive project health reports.

Get Phases

Retrieves all phases defined within your Baton projects. Phases are structured groupings of tasks that represent distinct stages of an implementation, such as Discovery, Configuration, Testing, and Go-Live. Use this endpoint to analyze phase-level progress and identify where projects are spending the most time.

  • This endpoint returns all phases across all projects, including phase names, order, associated project IDs, and completion status.
  • Phase records reference their parent project by project ID and can be joined with task records to understand which tasks belong to each phase.

Get Templates

Retrieves all project templates available in your Baton organization. Templates are reusable project structures that standardize the implementation process across similar client engagements. Use this endpoint to audit your template library or synchronize template data with external project management or documentation systems.

  • This endpoint returns all templates including template names, descriptions, associated tasks and phases, and metadata about when each template was created or last updated.
  • No additional configuration is required beyond selecting this template.

Templates in Baton are typically created from successful completed projects. Retrieving template data is useful for maintaining an up-to-date catalog of your standardized implementation workflows.

Get Users

Retrieves all users within your Baton organization. Use this endpoint to maintain a current list of team members, their roles, and account statuses for user management, access auditing, or integration with HR and identity management systems.

  • This endpoint returns all users in your Baton organization, including user IDs, names, email addresses, roles, and account status.
  • User IDs are referenced in task and project records as assignees, making this endpoint useful for enriching task and project data with full user details.

Get Companies

Retrieves all companies (clients or internal organizations) associated with your Baton account. Companies represent the client organizations for which implementation projects are being managed. Use this endpoint to maintain a client roster, analyze implementation activity by client, or synchronize client data with your CRM.

  • This endpoint returns all companies in your Baton organization, including company IDs, names, and associated metadata.
  • Company IDs are referenced in project records, allowing you to join company data with project records to build client-level implementation reports.

Get Time Entries

Retrieves all time entries logged against tasks in your Baton projects. Time entries capture the hours spent by team members on specific tasks, enabling time tracking, billing, resource utilization analysis, and project costing.

  • This endpoint returns all time entries including the associated task ID, user ID, logged duration, date, and any notes recorded with the entry.
  • Time entry records reference both tasks and users by ID, allowing you to join this data with task and user records for comprehensive time tracking reports.

Time entries are only available if your team actively logs time in Baton. If time tracking has not been enabled or used in your organization, this endpoint may return limited or no data.

Get Activity

Retrieves the activity audit log for your Baton organization. The activity stream records changes made to projects, tasks, and other resources — providing a chronological history of actions taken by users. Use this endpoint for audit compliance, change tracking, or monitoring real-time activity across your implementation portfolio.

  • Activity records include the type of action performed (create, update, delete), the resource affected, the user who performed the action, and a timestamp.
  • This endpoint is particularly useful for building audit trails or detecting configuration changes across projects.

Get Project Attachments

Retrieves metadata for all file attachments associated with projects in your Baton organization. Use this endpoint to track documents, deliverables, and other files uploaded to projects for compliance auditing or document management purposes.

  • This endpoint returns attachment metadata including file names, upload dates, associated project IDs, and uploader information. File content itself is not retrieved — only metadata.
  • Attachment records reference their parent project by project ID.

Get Task Attachments

Retrieves metadata for all file attachments associated with tasks in your Baton organization. Use this endpoint to track task-level documentation and deliverables for audit or document management purposes.

  • This endpoint returns task attachment metadata including file names, upload dates, associated task IDs, and uploader information. File content itself is not retrieved — only metadata.
  • Attachment records reference their parent task by task ID and can be joined with task records for a complete picture of task 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

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

    • GET: For retrieving data from the API
    • POST: For sending data to the API or triggering actions
    • PUT: For updating existing data
    • PATCH: For partial updates to existing data
    • DELETE: For removing data

API Endpoint URL

  1. Enter the URL of the Baton API endpoint from which this source will fetch data in the Set API URL field. Baton API endpoints follow the pattern https://app.hellobaton.com/api/{company}/{resource}/, where {company} is your Baton company identifier and {resource} is the specific resource you want to retrieve (e.g., projects, tasks, users).

Ensure the API endpoint URL is correct and accessible with your current credentials. You can test the endpoint using the Test button after configuring the URL. For a complete list of available Baton API endpoints and their parameters, refer to the Baton API documentation.

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.

Macros are particularly useful for APIs that support date range filtering — for example, retrieving only Baton activity records or time entries created within a specific date range.

  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 for constructing Baton API calls that reference specific project IDs, task IDs, or other identifiers retrieved from other data sources in your Nexla environment.

  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 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 Baton API responses contain metadata, pagination information, or other data that you don't need for your analysis.

For example, when retrieving a list of projects or tasks, the Baton API typically returns an array of records along with response metadata. 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).

    • For responses in XML format, enter the XPath that points to the object/array containing relevant data. XPath uses slash notation (e.g., /response/data/item to access item elements within a data element).

    Path to Data Example:

    If the Baton API response is in JSON format and includes a top-level array named results that contains the relevant records, the path to the data would be entered as $.results[*].

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 retrieving a list of Baton tasks, the API response may include pagination metadata such as total count or page information alongside the array of task records. You can specify a path to this metadata to include it with each record in the generated Nexset(s).

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

    You do not need to include any headers already present in the credentials. The Baton API authentication header is automatically included by Nexla based on your 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 Baton 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.