Skip to main content

Data Source

Follow the instructions below to create a new data flow that ingests data from a Toggl source in Nexla.
toggl_api.png

Toggl

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

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

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

    Fetch Resources for Logged in User

    This endpoint template retrieves a list of resources for the authenticated user from your Toggl account. Use this template when you need to access user-specific resources such as projects, clients, workspaces, or other Toggl resources for analysis, reporting, or integration purposes.

    • Enter the Resource Type in the Resource Type field. This should be the type of Toggl resources you want to retrieve (e.g., projects, clients, workspaces, time_entries, etc.). The Resource Type determines which type of resources will be retrieved. Available resource types include projects, clients, workspaces, time_entries, and other user-specific resources.
    • Optionally, enter the API Version in the API Version field. This should be the Toggl API version to use (e.g., v9). The default API version is typically v9. The API Version determines which version of the Toggl API will be used for the request.

    This endpoint returns a list of resources for the authenticated user from your Toggl account, including resource IDs, names, and other resource metadata. The endpoint returns all resources of the specified type for the authenticated user.

    The Resource Type can be selected from available options (e.g., projects, clients, workspaces, time_entries, etc.). The API Version determines which version of the Toggl API will be used. For detailed information about resources, API response structures, and available resource types, see the Toggl API 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​

Toggl data sources can be manually configured to ingest data from any valid Toggl 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 Toggl sources, such as sources that use chained API calls to fetch related data or sources that require custom query parameters or filters.

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 Toggl API from the Method pulldown menu. Toggl API typically uses GET method for retrieving data from endpoints.

API Endpoint URL​

  1. Enter the URL of the Toggl API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL to your Toggl endpoint (e.g., https://api.track.toggl.com/api/v9/me/projects, https://api.track.toggl.com/api/v9/me/clients). Include any required path parameters in the URL.

Ensure the API endpoint URL is correct and accessible with your current credentials. The Toggl API endpoint URL should include the API base URL (https://api.track.toggl.com/api/v9/) and the resource path. You can test the endpoint using the Test button after configuring the URL.

Response Data Path​

  1. Enter the JSONPath expression in the Response Data Path field to specify which part of the API response should be treated as the relevant data by Nexla. For Toggl API responses, use $.{resource_type}[*] to extract all items from the resource array (e.g., $.projects[*], $.clients[*]), or $[*] to extract all items from the response array, depending on your endpoint.

The JSONPath expression must correctly reference the structure of your Toggl API response. Toggl API responses typically have resource arrays at the root level or nested within objects. Ensure your JSONPath expression matches the structure returned by your specific endpoint. The JSONPath expression determines which data will be extracted and processed by Nexla.

Pagination (if applicable)​

  1. If your endpoint supports pagination, configure the pagination settings in the Pagination section. Toggl API may use different pagination mechanisms depending on the endpoint. Select the pagination type that matches your endpoint's pagination mechanism.

  2. Configure the pagination parameters based on your selected pagination type. For incrementing page-based pagination, specify the page parameter name, page size parameter name, and starting page number.

Save the Data Source​

  1. Once all of the relevant steps in the above sections have been completed, click the Next button to proceed with the rest of the data flow configuration, or click Save to save the data source configuration for later use.