Workfloows icon

Workfloows

Use Workfloows API to get data

Actions6

Overview

This node integrates with the Workfloows API to manage and retrieve information about jobs, tools, and health status. Specifically, for the Job - List operation, it fetches a list of active jobs along with current limits status from the Workfloows service.

Typical use cases include:

  • Monitoring active jobs running in your Workfloows account.
  • Checking job limits and usage statistics.
  • Automating workflows that depend on job statuses or job lists.

For example, you might use this node to periodically retrieve all active jobs and trigger alerts if certain thresholds are exceeded or to display job statuses in a dashboard.

Properties

Name Meaning
Simplify Whether to return a simplified version of the response instead of the raw data. Options: true (default) or false.

Output

The output is a JSON array where each item corresponds to the API response for the requested jobs list.

  • If Simplify is enabled (true), the output contains only the jobs array extracted from the API response's response.jobs field, providing a cleaner and more focused dataset.
  • If Simplify is disabled (false), the full raw API response object is returned, which includes additional metadata beyond just the jobs list.

No binary data is produced by this operation.

Example simplified output structure:

[
  {
    "id": "job-id-1",
    "status": "active",
    "createdAt": "2024-01-01T12:00:00Z",
    "type": "some-job-type",
    ...
  },
  {
    "id": "job-id-2",
    "status": "completed",
    "createdAt": "2024-01-02T08:30:00Z",
    "type": "another-job-type",
    ...
  }
]

(Note: The exact fields inside each job depend on the Workfloows API response.)

Dependencies

  • Requires an API key credential for authenticating with the Workfloows API.
  • The node makes HTTP requests to the Workfloows API endpoints at https://api.workfloo.ws/v0/jobs.
  • No additional external dependencies are required.

Troubleshooting

  • Authentication errors: Ensure the API key credential is correctly configured and has sufficient permissions.
  • Empty or missing job list: Verify that there are active jobs in your Workfloows account. Also, check network connectivity and API availability.
  • Unexpected response format: If Simplify is enabled but the output seems incomplete, try disabling Simplify to inspect the full raw response for debugging.
  • API rate limits: If you encounter rate limit errors, consider adding delays between requests or checking your account limits.

Links and References

Discussion