HCSS HeavyJob Trigger icon

HCSS HeavyJob Trigger

Get data from HCSS Heavy Job API

Overview

This node acts as a trigger for the HCSS HeavyJob API, specifically monitoring time card data. It periodically polls the API to detect new or updated time cards and emits this data when changes occur. This is useful in scenarios where you want to automate workflows based on time card events, such as payroll processing, attendance tracking, or project management updates.

For example:

  • Triggering a workflow whenever a new time card is created to start approval processes.
  • Detecting updates in existing time cards to synchronize changes with other systems.

Properties

Name Meaning
Event The type of time card event to trigger on. Options: "New Time Card" or "Updated in Time Card".
Additional Fields Extra optional settings. Currently supports: "Load Sample Data" (boolean) which loads sample data from the system instead of recent data.

Output

The node outputs JSON data representing time card information retrieved from the HCSS HeavyJob API.

  • For the New Time Card event, it outputs an array of new time card objects exactly as received from the API.
  • For the Updated in Time Card event, it outputs an array of updated time card objects, each augmented with:
    • time_card_id: the original ID of the time card.
    • id: a unique identifier combining the time card ID and the last modified timestamp.

No binary data output is produced by this node.

Dependencies

  • Requires an API key credential for authenticating with the HCSS HeavyJob API.
  • The node uses a helper function (hcssApiRequest) to make HTTP GET requests to the /timeCardInfo endpoint.
  • Polling interval defaults to 30 minutes but extends to 3 days if loading sample data.
  • Proper configuration of the API credentials within n8n is necessary for successful operation.

Troubleshooting

  • Common issues:

    • Authentication failures due to incorrect or missing API credentials.
    • Network errors or API downtime causing request failures.
    • No data returned if the polling interval or filters do not match any new or updated time cards.

  • Error messages:

    • Errors thrown during API requests are logged and rethrown as node operation errors with the original message.
    • If you see messages related to failed API calls, verify your API key and network connectivity.
    • If no data is emitted, check that the selected event matches actual changes in the source system.

Links and References

Discussion