CT Coach Dev icon

CT Coach Dev

Interact with HttpBin API

Actions6

Overview

This node interacts with a Coach API to update the current KPI (Key Performance Indicator) value for a specific user. It is useful in scenarios where you want to programmatically track and update performance metrics or KPIs of users within an organization or team. For example, after processing sales data or employee performance results, this node can update the KPI values in the system to keep records current.

Properties

Name Meaning
User ID The unique identifier of the user whose KPI value you want to update.
KPI ID The identifier of the KPI that you want to update for the user.
KPI Value The new value to set for the specified KPI.
KPI Date (Optional) The date associated with the KPI value update. If not provided, the current date may be assumed.

Output

The node outputs JSON data representing the response from the Coach API after attempting to update the user's KPI value. This typically includes confirmation of the update or details about the updated KPI record. The output does not include binary data.

Example output structure:

{
  "json": {
    // Response fields from the API, e.g.:
    "success": true,
    "updatedKpiId": "12345",
    "userId": "67890",
    "kpiValue": "100",
    "kpiDate": "2024-06-01"
  }
}

Dependencies

  • Requires an API key credential and company ID credential configured in n8n to authenticate requests to the Coach API.
  • The node sends HTTP PUT requests to the endpoint https://dev.mymatrixapp.com/crmApi/update-kpi.
  • Proper network access to the Coach API endpoint is necessary.

Troubleshooting

  • Authentication errors: Ensure that the API key and company ID credentials are correctly configured and valid.
  • Invalid or missing parameters: The User ID, KPI ID, and KPI Value are required. Missing these will cause the API request to fail.
  • API endpoint unreachable: Verify network connectivity and that the API URL is correct.
  • Unexpected API responses: Check if the KPI ID and User ID exist in the system; invalid IDs may cause errors.
  • Date format issues: If providing KPI Date, ensure it matches the expected format by the API (usually ISO 8601).

Links and References

Discussion