Pulse Workflow icon

Pulse Workflow

Workflow actions from Pulse API

Actions26

Overview

This node enables managing project documents within a project management system via the Pulse API. Specifically, the "Add Project Document" operation allows users to create and add new documents to a specified project. This is useful for teams needing to organize and share various types of project-related documents such as plans, training materials, client instructions, or commercial documents.

Practical examples include:

  • Uploading a new project plan document URL to a project for team access.
  • Adding client instructions as a document linked to a project for easy reference.
  • Sharing commercial documents related to a project with appropriate access rights.

Properties

Name Meaning
Name * The name/title of the document being added.
Category * The category/type of the document. Options are:
• Project Plan
• Training Book
• Client's Instruction
• Commercial Document
URL * The URL link where the document is hosted or accessible.
Rights * Access permissions for the document. Can be provided as a comma-separated list (e.g., "financial,lead") or an array of strings (e.g., ["financial", "lead"]). Access rules:
• Client users can only add documents with "client" right.
• Supervisors require "lead" right.
• Financial users require "financial" right.
Project ID * The unique identifier of the project to which the document will be added.

(* indicates required fields)

Output

The node outputs a JSON object representing the newly created project document. This typically includes details such as the document's ID, name, category, URL, rights, associated project ID, timestamps, and other metadata returned by the Pulse API.

No binary data output is involved in this operation.

Dependencies

  • Requires an active connection to the Pulse API via an API key credential configured in n8n.
  • The node depends on the Pulse API service being available and accessible.
  • Proper permissions must be granted to the API key to create project documents.
  • The user must supply valid project IDs and URLs for documents.

Troubleshooting

  • Common Issues:

    • Invalid or missing project ID: Ensure the project ID exists and is correctly entered.
    • Incorrect rights format: Rights must be either a comma-separated string or an array of strings matching allowed roles.
    • Insufficient permissions: The API key used must have rights to add documents with the specified access permissions.
    • Invalid URL: The URL must be a valid link accessible by the system or users.

  • Error Messages:

    • "The operation "createProjectDocument" is not supported for resource "projectDocuments"!" — Indicates a misconfiguration of operation or resource; verify correct selection.
    • API errors related to authentication or authorization — Check API credentials and permissions.
    • Validation errors from the API about missing or invalid fields — Review input properties for correctness.

Resolving these usually involves verifying inputs, ensuring proper API credentials, and confirming that the Pulse API service is operational.

Links and References

Discussion