Pulse Workflow icon

Pulse Workflow

Workflow actions from Pulse API

Actions23

Overview

This node interacts with the Pulse API to perform various workflow actions related to project data management. Specifically, for the List Project Data operation, it retrieves a list of project data entries from the Pulse system. This is useful in scenarios where you want to fetch and process multiple pieces of data associated with projects, such as metadata, custom fields, or other structured information stored within a project.

Practical examples include:

  • Automating reporting by fetching all project data entries and summarizing key metrics.
  • Integrating project data into other systems by exporting lists of project-related information.
  • Filtering and sorting project data dynamically based on specific criteria to support dashboards or analytics.

Properties

Name Meaning
Include Related Resources (included) Select related resources to include in the response. Currently supports including the "Project" resource to enrich the project data with project details.
Additional Fields (additionalFields) A collection of optional parameters to customize the list request:
- Sort: Specify sort order by field name (e.g., "created_at" ascending or "-created_at" descending).
- Page Number: The page number for paginated results (default 1).
- Page Size: Number of results per page (default 20).
- Filters: Apply filters by specifying keys and comma-separated values to narrow down results.
- Fields: Specify which fields to include in the response for particular resource types by providing resource type and comma-separated field names.

Output

The node outputs an array of JSON objects representing the project data entries retrieved from the Pulse API. Each object corresponds to one project data record and includes fields as returned by the API, potentially enriched with related project information if requested.

If binary data were involved (not indicated here), it would be included in a separate binary property, but this operation focuses on JSON data output only.

Dependencies

  • Requires connection to the Pulse API via an API key credential configured in n8n.
  • The node depends on the Pulse API helper utilities bundled with the node implementation to handle authentication and API requests.
  • Pagination, filtering, and sorting are supported through query parameters sent to the Pulse API.

Troubleshooting

  • Common issues:

    • Incorrect or missing API credentials will cause authentication failures.
    • Using unsupported filter keys or invalid pagination parameters may result in API errors.
    • Requesting fields or related resources not available in the API response can lead to incomplete data or errors.

  • Error messages:

    • "The operation "getProjectDataList" is not supported for resource "projectData"!" — indicates a mismatch between selected resource and operation; ensure correct configuration.
    • API errors related to rate limits or invalid parameters will be passed through; check the API documentation for valid parameter values.

  • Resolution tips:

    • Verify API credentials and permissions.
    • Double-check filter keys and values for correctness.
    • Use default pagination settings initially to confirm connectivity before customizing.

Links and References

Discussion