N8N Tools - Yup.chat icon

N8N Tools - Yup.chat

Send messages and manage communications through Yup.chat

Actions17

Overview

This node integrates with the Yup.chat API to manage messaging and communication tasks across multiple channels, including SMS, WhatsApp, RCS, and Omni Rooms. Specifically, for the Omni Rooms resource with the Get Messages operation, it retrieves messages from a specified chat room.

Use cases include:

  • Fetching conversation history from a particular chat room in an omnichannel messaging platform.
  • Monitoring or archiving messages exchanged within a specific room.
  • Integrating chat room message data into workflows for analysis, reporting, or triggering other automation steps.

Example: Retrieve the last 50 messages from a customer support chat room to analyze recent interactions.

Properties

Name Meaning
Room ID The unique identifier of the chat room from which to retrieve messages.
Return All Whether to return all messages available or limit the number of results returned.
Limit Maximum number of messages to return if "Return All" is false. Value range: 1 to 500.

Output

The node outputs an array of JSON objects representing messages retrieved from the specified Omni Room. Each item corresponds to one message with its associated data as provided by the Yup.chat API.

  • The exact structure of each message object depends on the API response but typically includes fields such as message content, sender info, timestamps, and metadata.
  • No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for Yup.chat to authenticate requests.
  • The base URL for the Yup.chat API defaults to https://api.yup.chat but can be overridden via credentials.
  • Proper configuration of the Yup.chat API key credential in n8n is necessary.

Troubleshooting

  • Common issues:

    • Invalid or missing Room ID will cause the API request to fail.
    • Exceeding rate limits or invalid API keys will result in authentication errors.
    • Requesting too many messages without enabling "Return All" may truncate results unexpectedly.
  • Error messages:

    • Errors from the Yup.chat API are propagated; typical messages include unauthorized access, not found (invalid room), or bad request due to malformed parameters.
    • To resolve, verify the Room ID, ensure the API key is valid and has sufficient permissions, and adjust the "Limit" or "Return All" settings appropriately.

Links and References

Discussion