Unipile icon

Unipile

Interact with Unipile API

Overview

The node interacts with the Unipile API, specifically to start a new chat session within the Messaging resource. It allows users to initiate chats by sending a raw JSON body describing the chat parameters. This is useful in scenarios where automated workflows need to programmatically create chat conversations, such as customer support automation, team collaboration setups, or triggering chat-based notifications.

For example, a user might configure this node to start a chat with specific participants and initial messages by providing the appropriate JSON structure in the input.

Properties

Name Meaning
Body (JSON) Raw JSON body to start a new chat. This should contain all necessary parameters as defined by the Unipile API for initiating a chat session.

Output

The node outputs JSON data representing the response from the Unipile API after attempting to start a chat. This typically includes details about the newly created chat session, such as chat ID, participants, timestamps, and status. The output does not include binary data.

Dependencies

  • Requires an API key credential for authenticating with the Unipile API.
  • The base URL for API requests is configured via credentials.
  • The node expects the Unipile API to be accessible and properly configured to accept chat start requests.

Troubleshooting

  • Common issues:
    • Invalid or malformed JSON in the "Body (JSON)" property can cause request failures.
    • Missing or incorrect API credentials will result in authentication errors.
    • Network connectivity problems may prevent the node from reaching the Unipile API.
  • Error messages:
    • Authentication errors usually indicate invalid or missing API keys; verify credentials.
    • Validation errors from the API often mean the JSON body lacks required fields or has incorrect formats; check the API documentation for correct payload structure.
    • Timeout or network errors suggest connectivity issues; ensure the API endpoint is reachable.

Links and References

Discussion