Pulse Workflow icon

Pulse Workflow

Workflow actions from Pulse API

Actions23

Overview

This node integrates with the Pulse API to perform workflow actions related to project documents, among other resources. Specifically, for the "Project Document" resource and the "List Project Documents" operation, it retrieves a list of documents associated with projects. This is useful in scenarios where users need to fetch, filter, sort, and paginate through project documents programmatically within an automation workflow.

Practical examples include:

  • Automatically retrieving all documents related to a specific project for reporting or archival.
  • Filtering project documents by certain metadata fields or date ranges.
  • Paginating through large sets of project documents to process them in batches.

Properties

Name Meaning
Additional Fields A collection of optional parameters to customize the document listing:
- Sort Sort order of 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 results per page (default is 20).
- Filters One or more filters to narrow down results by specific keys and their comma-separated values.
- Fields Specify which fields to include in the response, grouped by resource type, as comma-separated lists.

Output

The node outputs JSON data containing the list of project documents matching the specified criteria. The structure typically includes an array of document objects with their properties such as IDs, names, metadata, creation dates, etc., depending on the requested fields.

If binary data output is supported (not explicitly shown here), it would represent the actual content of documents or downloadable URLs, but for the "List Project Documents" operation, the output is primarily JSON metadata about documents.

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 in the source code to handle authentication and API requests.
  • No additional external services are required beyond the Pulse API.

Troubleshooting

  • Common Issues:

    • Incorrect or missing API credentials will cause authentication failures.
    • Using unsupported operations or resources will throw errors indicating the operation/resource is not supported.
    • Pagination parameters out of range may result in empty responses.
    • Improperly formatted filters or field lists may cause API errors or unexpected results.

  • Error Messages:

    • "The operation \"getProjectDocumentList\" is not supported for resource \"projectDocuments\"!" indicates a mismatch between selected operation and resource.
    • "The resource \"projectDocuments\" is not supported!" means the resource name is invalid or misspelled.
    • API errors returned from Pulse API will be passed through; check the error message for details like rate limits or permission issues.

  • Resolutions:

    • Verify API credentials and permissions.
    • Confirm correct resource and operation names.
    • Validate filter keys and values against Pulse API documentation.
    • Adjust pagination parameters to valid ranges.

Links and References

Discussion