Pulse Office Action icon

Pulse Office Action

Office actions from Pulse API

Actions17

Overview

The node enables creating a new planning schedule within an organizational context using the Pulse API. It is designed to help automate and manage work schedules by defining key parameters such as the planning name, timezone, organizational unit, working hours per day, and detailed daily schedules.

This node is beneficial in scenarios where organizations need to programmatically set up or update work plans for teams or departments, ensuring consistent scheduling aligned with business hours and timezones. For example, HR or operations teams can use this node to create standardized work plans for different units, reflecting their specific working hours and days.

Properties

Name Meaning
Name * The name of the planning schedule being created.
Timezone * The timezone applicable to the planning (e.g., "Africa/Nairobi"), ensuring correct time alignment.
Organizational Unit * The identifier or name of the organizational unit for which the planning applies.
Working Hours Per Day Number of working hours expected per day (default is 8).
Schedule * JSON object defining the daily schedule with start and end times for each day. Format:
{ "day": ["start1", "end1", "start2", "end2"] }
Example: { "monday": ["8:00", "12:00", "14:00", "18:00"], "tuesday": ["8:00", "12:00", "14:00", "18:00"] }

Output

The node outputs a JSON object representing the newly created planning resource as returned by the Pulse API. This typically includes details such as the planning ID, name, timezone, organizational unit, working hours, and schedule configuration.

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to the Pulse API via an API key credential.
  • The node depends on the Pulse API helper utilities bundled within the node's codebase.
  • Proper configuration of the API authentication credentials in n8n is necessary for successful execution.

Troubleshooting

  • Common Issues:

    • Invalid or missing required properties such as name, timezone, or organizational unit will cause errors.
    • Incorrectly formatted JSON in the schedule property may lead to parsing errors or API rejection.
    • Network or authentication failures with the Pulse API can prevent creation.

  • Error Messages:

    • "Unknown operation: "createPlanning" is not supported for resource "planning"!" — indicates a misconfiguration of the operation or resource selection.
    • API error messages related to invalid input data should be checked against the property definitions, especially the schedule JSON format.
    • Authentication errors suggest checking the API key credential setup.

  • Resolution Tips:

    • Validate all required fields before execution.
    • Use proper JSON formatting tools to ensure the schedule property is valid.
    • Confirm API credentials are correctly configured and have sufficient permissions.

Links and References

Discussion