Overview

This node interacts with the Workboard API to perform various operations on different resources such as users, goals, teams, metrics, activities, workstreams, tags, datastreams, and webhooks. Specifically, for the Workstream resource with the Delete operation, it sends a PATCH request to mark a workstream as deleted based on the provided Workstream ID. This node is useful for automating management tasks in Workboard, such as deleting workstreams, updating activities, or retrieving team data.

Use Case Examples

1. Deleting a specific workstream by providing its Workstream ID.
2. Updating details of a workstream or activity using additional fields.
3. Retrieving all activities associated with a particular workstream.

Properties

Output

JSON

• success - Indicates whether the delete operation was successful.
• error - Error message if the operation failed.
• resource - The resource type involved in the operation, e.g., workstream.
• operation - The operation performed, e.g., delete.
• itemIndex - Index of the item in the input data array, useful for error tracking.

Dependencies

• Requires an API key credential for Workboard API authentication (bearer token).
• Needs the base URL for the Workboard API, defaulting to https://www.myworkboard.com/wb/apis if not provided.

Troubleshooting

• Common issues include invalid or missing Workstream ID, resulting in API errors.
• Authentication failures due to incorrect or expired bearer token.
• Network or connectivity issues preventing API requests.
• Errors in additional fields formatting, especially JSON fields like tags or comments.
• If the node is set to continue on fail, errors will be returned in the output array with error messages for each failed item.

Links

• Workboard API Documentation - Official API documentation for Workboard, useful for understanding available endpoints and parameters.