YOOV Agent icon

YOOV Agent

Interact with YOOV Agent API

Overview

The "YOOV Agent" node for n8n allows you to send messages via the YOOV Agent API. Specifically, when using the Message resource with the Send operation, this node sends a message from a specified sender to a chat room, optionally triggering a callback/webhook URL after sending. This is useful for automating chatbot interactions, notifications, or integrating YOOV Agent messaging into broader workflows.

Example scenarios:

  • Sending automated alerts or updates to a chatroom.
  • Relaying user input from another system into a YOOV Agent conversation.
  • Notifying a webhook endpoint after a message is sent.

Properties

Name Meaning
Chatbot ID The unique identifier of the chatbot that will send the message.
Sender ID The identifier of the sender (user or bot) within YOOV Agent.
Room ID The target chat room's identifier where the message will be delivered.
Content The text content of the message to be sent.
Callback/Webhook URL (Optional) A URL to receive a callback notification after the message is sent.

Output

The node outputs a JSON object containing the response from the YOOV Agent API after attempting to send the message. If an error occurs and "Continue On Fail" is enabled, the output will include an error field with the error message.

Example output (success):

{
  // ...fields as returned by YOOV Agent API, e.g.,
  "status": "success",
  "messageId": "abc123",
  "timestamp": "2024-06-01T12:34:56Z"
}

Example output (on error, with Continue On Fail):

{
  "error": "Invalid Chatbot ID"
}

Dependencies

  • YOOV Agent API: Requires access to the YOOV Agent API.
  • API Credentials: You must configure the yoovAgentApi credential in n8n for authentication.
  • n8n Configuration: No special environment variables are required beyond standard credential setup.

Troubleshooting

Common issues:

  • Missing or invalid credentials: Ensure the yoovAgentApi credential is correctly set up in n8n.
  • Incorrect property values: Double-check that Chatbot ID, Sender ID, and Room ID are valid and exist in your YOOV Agent account.
  • Webhook URL errors: If a callback URL is provided, ensure it is reachable and accepts POST requests.

Error messages:

  • "Invalid Chatbot ID": The provided Chatbot ID does not exist or is incorrect. Verify the value.
  • "Missing required parameter": One or more required fields (Chatbot ID, Sender ID, Room ID, Content) are empty.
  • "Network error": There may be connectivity issues between n8n and the YOOV Agent API.

Links and References

Discussion