StevoChat icon

StevoChat

Interact with StevoChat API

Actions12

Session → Connect

AI-generated

Overview

The node interacts with the StevoChat API to manage chat sessions and messaging. Specifically, the Session - Connect operation establishes a connection to a StevoChat session, allowing the user to subscribe to different types of real-time updates such as all events, messages, or contacts. This is useful for scenarios where you want to listen for incoming messages or contact changes immediately after connecting.

Practical examples include:

  • Automatically subscribing to all session events to monitor chat activity in real time.
  • Subscribing only to new messages to trigger workflows when a message arrives.
  • Connecting immediately upon execution or delaying connection based on workflow logic.

Properties

Name Meaning
Subscribe What to subscribe to upon connection. Options: All (all events), Messages, Contacts.
Immediate Whether to connect immediately (true/false). If false, connection may be deferred.

Output

The output is a JSON object representing the response from the StevoChat API's /session/connect endpoint. It typically contains details about the established session connection and subscription status.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the StevoChat API.
  • The node depends on the StevoChat API being accessible and properly configured.
  • No additional environment variables are explicitly required beyond the API authentication.

Troubleshooting

  • Common issues:

    • Connection failures due to invalid or missing API credentials.
    • Subscription errors if an unsupported subscription type is selected.
    • Network connectivity problems preventing access to the StevoChat API.

  • Error messages:

    • Errors returned from the API will be surfaced, e.g., unauthorized access or invalid parameters.
    • If the node is set to continue on fail, errors will be included in the output JSON under an error field.

  • Resolutions:

    • Verify that the API key credential is correctly configured and has necessary permissions.
    • Ensure the subscription option matches one of the allowed values: All, Messages, or Contacts.
    • Check network connectivity and API endpoint availability.

Links and References

Discussion