CoachTrigger Dev icon

CoachTrigger Dev

Interact with coach trigger action development server API

Overview

This node integrates with the Coach Trigger development server API to perform various operations related to user data, activities, messages, and reports within a coaching or CRM system. It supports multiple authentication methods and provides endpoints for retrieving user profiles, KPI values, activity lists, message histories, and updating message translations or AI coach messages.

Common scenarios where this node is beneficial include:

  • Fetching detailed user information by CRM ID or user ID.
  • Retrieving and updating key performance indicators (KPIs) for users.
  • Managing and sending messages as an AI coach or updating message translations.
  • Accessing daily or weekly report data and statuses.
  • Obtaining lists of user questions or activities.

Practical examples:

  • A company wants to automate fetching user KPIs daily to monitor performance trends.
  • Sending personalized AI-generated coaching messages to users based on their activity.
  • Updating message translations dynamically in a multilingual coaching environment.
  • Generating daily or weekly reports for team leaders automatically.

Properties

Name Meaning
Authentication Choose between "Company Api" or "System Api" authentication methods.

The node also supports many other input properties depending on the selected operation, such as:

Name Meaning
crmUserId ID of the CRM user to get data for (used in "getUserData").
teamId ID of the team to get data for (used in "getTeamActivitiesList").
userId ID of the user to get data for (used in multiple operations like KPI retrieval, reports).
coachId ID of the coach (optional, used in "getUserProfile").
activityDate Date of the activity (used in "getCurrentKpiValue").
activityId Activity ID (used in "getCurrentKpiValue").
kpiId KPI ID for updating current KPI data (required in "updateUserCurrentKpiValue").
kpiValue KPI value for updating current KPI data (required in "updateUserCurrentKpiValue").
kpiDate KPI date for updating current KPI data (optional in "updateUserCurrentKpiValue").
messageId ID of the message to update translation or AI message (required in relevant operations).
messageTranslation Translation text for the message (required in "updateMessageTranslation").
message Message content (used in message update and AI coach message creation).
coachUserId User ID of the coach (required in AI coach message operations).
receiverUserId User ID of the message receiver (required in AI coach message creation).
messageTranslated Translated message content (optional in AI coach message operations).
llmModel Language model used for AI message generation (optional).
tokenIn Token count input for AI message (optional).
tokenOut Token count output for AI message (optional).
runId Run identifier for AI message context (optional).
threadId Thread identifier for AI message context (optional).
senderId Sender's user ID (required in "getMessagesHistory").
receiverId Receiver's user ID (required in "getMessagesHistory").
messagesAmount Number of messages to retrieve (required in "getMessagesHistory").
date Date for report data or status retrieval (used in daily/weekly reports and questions list).
type Type indicator used in some message-related operations (optional).

Output

The node outputs JSON data corresponding to the response from the Coach Trigger API for each executed operation. The structure varies depending on the operation but generally includes:

  • User data objects (profiles, CRM data).
  • KPI values and updates.
  • Lists of activities or questions.
  • Message histories or updated message details.
  • Report data and statuses.

No binary data output is produced by this node.

Dependencies

  • Requires access to the Coach Trigger development server API at https://dev.mymatrixapp.com/crmApi.
  • Requires either a "Company Api" or "System Api" authentication credential configured in n8n.
  • Network connectivity to the API endpoint must be available.

Troubleshooting

  • Authentication errors: Ensure that the correct API credentials are provided and valid. Using the wrong authentication method for the chosen operation may cause failures.
  • Missing required parameters: Many operations require specific IDs (e.g., userId, crmUserId, messageId). Omitting these will result in errors.
  • Invalid JSON responses: If the API returns unexpected data, parsing errors might occur. Verify API availability and parameter correctness.
  • Network issues: Timeouts or connection errors indicate network problems or incorrect API URLs.
  • Operation not supported: Selecting an operation incompatible with the resource or missing required parameters can cause errors.

To resolve errors:

  • Double-check all required input fields for the selected operation.
  • Confirm API keys and permissions.
  • Review API documentation for parameter formats.
  • Test connectivity to the API endpoint outside n8n if needed.

Links and References

Discussion