Pulse Workflow icon

Pulse Workflow

Workflow actions from Pulse API

Overview

This node interacts with the Pulse API to perform workflow actions related to various resources, including Activities. Specifically, for the Activities resource and the Get List of Activities operation, it retrieves a paginated list of activities from the Pulse system. This is useful for scenarios where you want to fetch and process activity data such as task tracking, project updates, or team member assignments within an automation workflow.

Practical examples include:

  • Automatically retrieving recent activities to generate reports.
  • Filtering activities based on specific criteria to trigger notifications.
  • Integrating activity data into dashboards or other systems for real-time monitoring.

Properties

Name Meaning
Additional Fields A collection of optional parameters to customize the query:
- 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 in pagination (default is 1).
- Page Size Number of results per page (default is 20).
- Filters One or more filters to narrow down results. Each filter consists of:
Key: The field name to filter on.
Values: Comma-separated list of values to match.
- Fields Specify which fields to include in the response for particular resource types. Each entry includes:
Resource Type: The type of resource to specify fields for.
Fields: Comma-separated list of fields.

Output

The node outputs JSON data representing the list of activities retrieved from the Pulse API. The structure typically includes an array of activity objects, each containing details such as activity ID, description, timestamps, assigned members, status, and other relevant 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.

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.
  • No additional external services are required beyond the Pulse API.

Troubleshooting

  • Common Issues:

    • Incorrect or missing API credentials will cause authentication failures.
    • Using unsupported filter keys or invalid sort parameters may result in API errors.
    • Requesting pages beyond the available range will return empty results.
  • Error Messages:

    • "The operation "getActivityList" is not supported for resource "activities"!" — indicates a mismatch between selected resource and operation; ensure correct selections.
    • API errors related to invalid parameters will usually include descriptive messages from the Pulse API; verify input property values.
  • Resolutions:

    • Verify that the API key credential is correctly set up and has necessary permissions.
    • Double-check filter keys and values against Pulse API documentation.
    • Adjust pagination parameters to valid ranges.

Links and References

Discussion