Actions39
- Chatbot Actions
- Contact Actions
- Message Actions
- Panel Actions
- Sequence Actions
- Session Actions
Overview
This node interacts with the "Panel" resource of the WTS Chat API, specifically supporting operations related to managing annotations on cards within panels. The "Get All Annotation" operation retrieves all annotations associated with a specific card in a panel.
Typical use cases include:
- Fetching all notes or comments (annotations) linked to a particular card for review or processing.
- Integrating annotation data into workflows that require context or history from cards in project management or CRM systems.
- Automating reporting or auditing tasks by extracting annotation details programmatically.
For example, you might use this node to pull all annotations from a card representing a customer issue, then analyze or forward those notes to another system.
Properties
Name | Meaning |
---|---|
Card ID | The unique identifier of the card whose annotations you want to retrieve. |
CreatedAt.After | Filter annotations created after this date/time (format: YYYY-MM-DD hh:mm). |
CreatedAt.Before | Filter annotations created before this date/time (format: YYYY-MM-DD hh:mm). |
UpdatedAt.After | Filter annotations updated after this date/time (format: YYYY-MM-DD hh:mm). |
UpdatedAt.Before | Filter annotations updated before this date/time (format: YYYY-MM-DD hh:mm). |
Auto Pagination | Whether to automatically paginate through multiple pages of results, aggregating all items. |
Max Pages | Maximum number of pages to retrieve when auto pagination is enabled (1 to 100). |
Page Number | The page number to retrieve when auto pagination is disabled. |
Page Size | Number of items per page when auto pagination is disabled (1 to 100). |
Order By | Field name to sort the annotations by. |
Order Direction | Direction of sorting: Ascending or Descending. |
Note: For the "Get All Annotation" operation, only the Card ID and generic pagination/filter parameters are relevant.
Output
The output is an array of JSON objects, each representing an annotation linked to the specified card. Each annotation object typically includes fields such as:
- Annotation text or file URLs (depending on annotation type).
- Metadata about creation and update timestamps.
- Possibly user or tag information related to the annotation.
The node does not output binary data for this operation; it returns structured JSON data describing annotations.
Dependencies
- Requires an active connection to the WTS Chat API via an API key credential.
- The node uses the
WtsCrmService.getAllAnnotation
method internally to fetch annotations. - No additional environment variables or external services are required beyond the configured API key.
Troubleshooting
- Missing Card ID: If the Card ID parameter is empty or invalid, the node will throw an error indicating that the CardID must be filled in.
- API Errors: Network issues or invalid API keys will result in errors from the WTS API. Ensure the API key is valid and has appropriate permissions.
- Pagination Limits: When using auto pagination, setting a very high max page count may slow down execution or hit API rate limits.
- Date Filters Format: Date/time filters must follow the specified format (
YYYY-MM-DD hh:mm
) and respect the time zone; incorrect formats may cause filtering to fail or return no results.
Links and References
- WTS Chat API Documentation (general reference for API endpoints)
- n8n documentation on Creating Custom Nodes
- Best practices for Handling Pagination in APIs
This summary focuses on the "Panel" resource and the "Get All Annotation" operation as requested, based solely on static analysis of the provided source code and property definitions.