Pulse Workflow icon

Pulse Workflow

Workflow actions from Pulse API

Actions26

Overview

The node interacts with the Pulse API to perform various workflow actions related to project management. Specifically, for the Project resource and the List Projects operation, it retrieves a list of projects from the Pulse system. This is useful in scenarios where you want to automate fetching project data for reporting, synchronization, or further processing within an n8n workflow.

For example, you might use this node to:

  • Retrieve all active projects to generate status reports.
  • Fetch projects with specific filters (e.g., by creation date or status) for dashboard updates.
  • Paginate through large sets of projects to process them in batches.

Properties

Name Meaning
Additional Fields A collection of optional parameters to customize the project list retrieval:
- Sort Sort order of the results, e.g., "created_at" for ascending or "-created_at" for descending order.
- Page Number The page number to retrieve for paginated results (default is 1).
- Page Size Number of projects to return per page (default is 20).
- Filters One or more filters to narrow down the results. Each filter consists of a key and comma-separated values.
- Fields Specify which fields to include in the response for particular resource types, as comma-separated lists.

Output

The node outputs JSON data containing the list of projects retrieved from the Pulse API. The structure typically includes an array of project objects, each with properties such as project ID, name, status, creation date, and other metadata depending on the fields requested.

If binary data were involved (not applicable here), it would be summarized accordingly, but this operation returns only JSON data.

Example output snippet (simplified):

[
  {
    "id": "123",
    "name": "Project Alpha",
    "status": "active",
    "created_at": "2023-01-15T12:00:00Z"
  },
  {
    "id": "124",
    "name": "Project Beta",
    "status": "completed",
    "created_at": "2022-11-10T08:30:00Z"
  }
]

Dependencies

  • Requires an API key credential for authenticating with the Pulse API.
  • The node depends on the Pulse API service being accessible and properly configured.
  • No additional environment variables are explicitly required beyond the API authentication setup.

Troubleshooting

  • Common issues:

    • Authentication failures due to invalid or missing API credentials.
    • Pagination parameters out of range causing empty or partial results.
    • Incorrect filter keys or values leading to no matching projects.
    • Unsupported sort field names resulting in API errors.

  • Error messages:

    • "The operation \"getProjectList\" is not supported for resource \"projects\"!" — indicates a misconfiguration of the operation or resource.
    • Network or API errors will surface as error messages in the node output if "Continue On Fail" is enabled.

  • Resolutions:

    • Verify that the API key credential is correctly set up and has necessary permissions.
    • Check the spelling and validity of filter keys and sort fields.
    • Adjust pagination parameters to valid ranges.
    • Ensure the selected resource and operation match exactly as supported.

Links and References

Discussion