CoachTrigger Dev icon

CoachTrigger Dev

Interact with coach trigger action development server API

Overview

This node interacts with a Coach Trigger development server API to retrieve and manage various types of data related to users, activities, messages, and reports within a company context. Specifically, for the Activity resource and the Company: Get Master Activities List operation, it fetches a comprehensive list of all master activities available for the company.

Common scenarios where this node is beneficial include:

  • Integrating company activity data into workflows for reporting or analytics.
  • Synchronizing master activity lists from the Coach API to other systems.
  • Automating processes that depend on up-to-date activity definitions.

For example, a user might use this node to pull the master list of activities to display in a dashboard or to trigger alerts based on specific activities recorded in the system.

Properties

Name Meaning
Authentication Method of authentication to use when connecting to the API. Options: "Company Api", "System Api"

Note: The node supports two authentication methods selectable by the user:

  • Company Api: Uses an API key credential associated with the company.
  • System Api: Uses a system-level API key credential.

Output

The node outputs JSON data containing the response from the Coach API endpoint for the requested operation. For the Company: Get Master Activities List operation, the output JSON will contain the full list of master activities defined for the company.

The exact structure depends on the API response but typically includes an array or object detailing each activity's properties such as ID, name, description, and possibly metadata relevant to the company's activity tracking.

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 valid API credentials depending on the selected authentication method (either company API key or system API key).
  • The node uses HTTP POST requests with appropriate headers including the API keys for authorization.

Troubleshooting

  • Authentication errors: If the API key or system key is invalid or missing, the node will fail to authenticate. Ensure the correct credentials are configured in n8n and selected properly in the node.
  • API endpoint errors: Network issues or incorrect parameters may cause the API to return errors. Verify that required parameters are set correctly.
  • Parsing errors: The node attempts to parse the API response as JSON. If the response is malformed or unexpected, parsing may fail. Check the API status and response format.
  • Missing required parameters: Although the "Get Master Activities List" operation does not require additional parameters beyond authentication, other operations do. Make sure to provide all required inputs when switching operations.

Links and References


If you need details on other operations or resources, feel free to ask!

Discussion