TwentyDEV icon

TwentyDEV

Consume the Twenty API
Join our community

Actions252

Overview

This node operation updates a specific version of a workflow in the TwentyDEV system. It allows users to modify details such as the version's position, status, steps, trigger configuration, and name. This is useful for managing different iterations of workflows, enabling version control and lifecycle management (e.g., drafting, activating, deactivating, or archiving versions).

Practical examples include:

  • Updating a draft version of a workflow with new steps before activation.
  • Changing the status of a workflow version from "DRAFT" to "ACTIVE" to make it live.
  • Adjusting the trigger settings of a workflow version to respond to different events.

Properties

Name Meaning
Id The unique identifier of the workflow version object to update.
Depth Determines how much related nested data to include in the response:
- 0: Only the primary workflow version information.
- 1: Primary object plus directly related objects.
- 2: Includes related objects of related objects.
Position Numeric position of the workflow version, indicating its order or priority.
Status The current state of the workflow version. Possible values:
- DRAFT
- ACTIVE
- DEACTIVATED
- ARCHIVED
Steps JSON object describing the steps that compose the workflow version. This defines the sequence and logic of actions within the workflow.
Trigger JSON object defining the trigger configuration for the workflow version, specifying what event(s) cause the workflow to execute.
Name The human-readable name assigned to this workflow version.
Workflow Id Identifier of the parent workflow to which this version belongs.

Output

The node outputs the updated workflow version object in JSON format. The structure includes all fields of the workflow version, potentially enriched with nested related objects depending on the Depth parameter. This output reflects the new state of the workflow version after the update operation.

No binary data output is involved.

Dependencies

  • Requires an API key credential for authenticating requests to the TwentyDEV API.
  • The base URL for API requests is configured via credentials.
  • The node uses the TwentyDEV OpenAPI specification internally to build request properties and handle communication.

Troubleshooting

  • Invalid Id: If the provided workflow version ID does not exist, the API will likely return a "not found" error. Verify the ID is correct.
  • Malformed JSON: The Steps and Trigger properties expect valid JSON strings. Invalid JSON will cause parsing errors. Ensure these inputs are correctly formatted.
  • Unauthorized Access: Missing or invalid API credentials will result in authentication errors. Confirm that the API key credential is properly set up.
  • Invalid Status Value: Providing a status outside the allowed options will cause validation errors. Use only the specified statuses.
  • Depth Parameter Misuse: Setting an unsupported depth value may lead to unexpected responses or errors. Use only 0, 1, or 2.

Links and References

Discussion