Workboard - SJI icon

Workboard - SJI

Interact with Workboard API

Actions45

Webhook → Update Metric

AI-generated

Overview

This node interacts with the Workboard API to update metric progress via a webhook. It is designed to authenticate using a webhook hash and allows users to send additional fields to update the metric's details. This node is useful for automating metric updates in Workboard, such as progress tracking or status changes, triggered by external events or workflows.

Use Case Examples

  1. Automatically update a metric's progress when a related event occurs in another system.
  2. Use the webhook to push updates to a metric's description, notes, or tags from an external source.

Properties

Name Meaning
Webhook Hash The webhook hash used for authentication to securely update the metric via the webhook.
Additional Fields Optional fields to update various attributes of the metric, such as activity description, notes, owner, workstream, team, due date, state, priority, rating, effort, tags, and comments.

Output

JSON

  • success - Indicates whether the metric update via webhook was successful.
  • ``
    • *
      * `` - Additional response data from the Workboard API after updating the metric.

Dependencies

  • Workboard API with JWT Bearer Token authentication

Troubleshooting

  • Ensure the webhook hash is correct and valid for authentication; an incorrect hash will cause authentication failures.
  • Verify that the additional fields are formatted correctly, especially JSON fields like tags and comments, to avoid request errors.
  • Check network connectivity and API endpoint availability to prevent request timeouts or failures.
  • If the API returns an error, review the error message for details on missing or invalid parameters.

Links

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

Discussion