WTS Chat icon

WTS Chat

Get data from Wts API

Overview

This node integrates with the WTS Chat API to manage various resources such as contacts, messages, sessions, and panels. Specifically for the Panel resource and the Create Annotation Text operation, it allows users to add a textual annotation (note) to a specific card within a panel. This is useful in scenarios where you want to attach comments, reminders, or additional information to a card in a project management or CRM-like system.

Practical examples:

  • Adding a note to a customer support ticket card to provide context or updates.
  • Annotating a task card with instructions or feedback.
  • Logging internal comments on a sales opportunity card.

Properties

Name Meaning
cardId The unique identifier of the card within the panel where the annotation text will be added.
textMessage The content of the annotation text to add to the specified card.

Output

The output is a JSON object representing the newly created annotation note returned by the API. It typically includes details about the annotation such as its ID, text content, creation timestamp, and possibly metadata related to the card.

No binary data output is involved in this operation.

Example output structure (simplified):

{
  "id": "annotation-id",
  "text": "Your annotation text here",
  "createdAt": "2024-01-01T12:00:00Z",
  "cardId": "the-card-id"
}

Dependencies

  • Requires an active API key credential for authentication with the WTS Chat API.
  • The base URL used for API requests is https://api-test.helena.run.
  • Uses HTTP POST request to the endpoint /crm/v1/panel/card/{cardId}/note to create the annotation.
  • The node depends on the axios library for making HTTP requests.

Troubleshooting

  • Invalid or missing cardId: If the cardId parameter is empty or incorrect, the API call will fail. Ensure that the card ID exists and is correctly provided.
  • Empty textMessage: Submitting an empty annotation text might result in an error or no action. Always provide meaningful text.
  • Authentication errors: If the API key credential is invalid or expired, the request will be unauthorized. Verify the API key configuration.
  • Network issues: Connectivity problems can cause request failures. Check network access to the API endpoint.
  • API rate limits or server errors: The API may return errors if limits are exceeded or if there are server-side issues. Review error messages and retry accordingly.

Links and References

Discussion