Flowyteam icon

Flowyteam

Custom node for Flowyteam API

Actions101

OKR Objective → Update

AI-generated

Overview

The node provides integration with the Flowyteam API to manage OKR (Objectives and Key Results) objectives. Specifically, the "Update" operation for the "OKR Objective" resource allows users to modify existing objectives within their organizational OKR framework. This is useful for keeping objectives current as priorities shift or more information becomes available.

Typical use cases include:

  • Updating the title, weight, or timeline of an objective.
  • Adjusting visibility settings or access permissions.
  • Adding descriptive details or remarks to clarify the objective.
  • Changing confidence levels or linking the objective to key results or performance cycles.

For example, a manager might update an objective's end date to extend a deadline or change its weight to reflect shifting business priorities.

Properties

Name Meaning
Objective Title The title or name of the objective to be updated.
Weight The importance or weight assigned to the objective (e.g., "60").
Start Date The start date of the objective in MM/DD/YYYY format (e.g., "01/01/2025").
End Date The end date of the objective in MM/DD/YYYY format (e.g., "03/31/2025").
Additional Fields A collection of optional fields to provide extra details:
- Confidence Confidence level for the objective; options are Low (1), Medium (2), High (3).
- Current Cycle The ID of the current performance cycle associated with the objective.
- Description A textual description providing more context about the objective.
- Employee Access List of employee IDs who have access to view or edit this objective.
- Key Result Parent ID The ID of the parent key result linked to this objective.
- Leader Model ID Identifier for the leader model related to the objective.
- Objective Remarks Additional remarks or notes about the objective.
- Type The type/category of the objective, defaulting to "company".
- View Options Visibility setting for the objective; options are Everyone, Team Only, Private.
Objective ID The unique identifier of the objective to update (required).

Output

The node outputs JSON data representing the updated objective as returned by the Flowyteam API. This typically includes all the updated fields such as title, dates, weight, descriptions, access controls, and any metadata related to the objective.

If the API supports it, the output may also contain status or confirmation messages indicating successful update.

No binary data output is indicated for this operation.

Dependencies

  • Requires an active connection to the Flowyteam API.
  • Needs an API authentication token or API key credential configured in n8n to authorize requests.
  • The node depends on internal endpoint modules that handle the actual API calls for updating objectives.

Troubleshooting

  • Invalid Objective ID: If the provided objective ID does not exist or is incorrect, the API will likely return an error. Verify the ID before running the node.
  • Date Format Errors: Start and end dates must be in MM/DD/YYYY format. Incorrect formats may cause validation errors.
  • Missing Required Fields: Ensure all required fields (Objective Title, Weight, Start Date, End Date, Objective ID) are provided.
  • Permission Issues: If the API credentials lack sufficient permissions, updates may fail. Confirm the API key has rights to modify objectives.
  • API Rate Limits: Frequent updates may hit rate limits imposed by the Flowyteam API. Implement retries or delays if needed.

Common error messages will generally come from the API response and should be reviewed in the node execution logs for diagnosis.

Links and References

  • Flowyteam official API documentation (refer to the section on OKR Objectives)
  • n8n documentation on creating custom nodes and using API credentials
  • Best practices for date formatting and API error handling

Discussion