Workboard - SJI icon

Workboard - SJI

Interact with Workboard API

Goal → Create

AI-generated

Overview

This node interacts with the Workboard API to perform various operations on different resources such as users, goals, teams, metrics, activities, workstreams, datastreams, tags, and webhooks. Specifically, for the 'Goal' resource with the 'Create' operation, it allows users to create a new goal by sending the specified additional fields to the Workboard API. This node is useful for automating goal management workflows, such as creating new goals programmatically within a team or organization.

Use Case Examples

  1. Creating a new goal with specific attributes like owner, due date, priority, and tags.
  2. Automating the creation of goals based on external triggers or data sources.

Properties

Name Meaning
Additional Fields A collection of optional fields to specify details about the goal being created, such as owner, workstream, team, due date, state, priority, rating, effort, tags, and comments.

Output

JSON

  • success - Indicates whether the goal creation was successful
  • ``
    • ``
      * goalProperties - Properties of the created goal returned from the Workboard API

Dependencies

  • Workboard API with JWT Bearer Token authentication

Troubleshooting

  • Ensure the Workboard API credentials (JWT token and base URL) are correctly configured and valid.
  • Verify that all required fields for creating a goal are provided and correctly formatted.
  • Check network connectivity to the Workboard API endpoint.
  • Handle API errors gracefully by enabling 'Continue On Fail' to capture error messages in the output.

Links

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

Discussion