WTS Chat icon

WTS Chat

Get data from Wts API

Overview

This node interacts with the WTS Chat API to manage contacts and related data. Specifically, the "Contact" resource with the "Get By ID" operation retrieves detailed information about a contact by its unique identifier. It supports including additional details such as tags and custom fields.

Common scenarios where this node is beneficial include:

  • Fetching complete contact profiles for customer support or marketing automation.
  • Integrating contact data into workflows that require enriched contact information.
  • Synchronizing contact details from WTS Chat into other systems.

For example, you can use this node to get a contact's full profile including their tags and custom fields to personalize communication or segment contacts dynamically.

Properties

Name Meaning
Contact ID The unique identifier of the contact to retrieve.
Include Details Optional additional details to include in the response. Possible values: Tags, CustomFields

Output

The output is an array of JSON objects representing the contact data retrieved from the WTS Chat API. The structure includes standard contact fields (such as name, email, phone number) and optionally includes nested details like tags and custom fields if requested.

Example output JSON structure:

{
  "id": "string",
  "name": "string",
  "email": "string",
  "phonenumber": "string",
  "tags": [ /* array of tag objects, if included */ ],
  "customFields": { /* key-value pairs of custom fields, if included */ },
  ...
}

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the WTS Chat API.
  • The node uses the WtsCoreService.getContactById method internally to fetch contact data.
  • The base URL for API requests is https://api.wts.chat.

Troubleshooting

  • Invalid Contact ID: If the Contact ID is empty or invalid, the node will throw an error indicating the missing or incorrect ID. Ensure the Contact ID parameter is correctly set.
  • API Authentication Errors: If the API key is missing or invalid, authentication errors will occur. Verify that the API key credential is configured properly.
  • Network or API Errors: Any issues communicating with the WTS Chat API will result in errors wrapped as NodeApiError. Check network connectivity and API status.
  • Include Details Parameter: If invalid options are provided for "Include Details," the API may ignore them or return incomplete data. Use only supported options ("Tags", "CustomFields").

Links and References

Discussion