Gladly icon

Gladly

Interact with Gladly API

Overview

This node operation updates the typing indicator state in a message automation session. It is useful in scenarios where you want to programmatically control the typing status shown to users during automated conversations, such as indicating when an automated agent starts or stops typing a response. For example, in a customer support chatbot, this can enhance user experience by signaling that the system is actively preparing a reply.

Properties

Name Meaning
Session Id The unique identifier of the automation session where the typing indicator will be updated.
State The state of the typing indicator. Possible values: STARTED (typing started), STOPPED (typing stopped).

Output

The node outputs JSON data reflecting the result of updating the typing indicator for the specified session. This typically includes confirmation of the new typing state and any relevant metadata returned by the API. There is no binary output associated with this operation.

Dependencies

  • Requires an API key credential for authenticating with the external service managing message automation sessions.
  • The node sends HTTP requests to the configured API endpoint to update the typing indicator state.
  • Proper configuration of the API base URL and authentication credentials within n8n is necessary.

Troubleshooting

  • Common issues:
    • Invalid or expired session ID may cause the update to fail.
    • Incorrect or missing API authentication can lead to authorization errors.
    • Providing an unsupported state value will result in validation errors.
  • Error messages:
    • "Session not found" indicates the session ID does not exist or is incorrect.
    • "Unauthorized" suggests missing or invalid API credentials.
    • "Invalid state value" means the provided state is not one of the allowed options (STARTED, STOPPED).
  • Resolutions:
    • Verify the session ID is correct and active.
    • Ensure API credentials are properly set up and have required permissions.
    • Use only the supported state values as defined.

Links and References

  • No direct links available from the source code. Consult the external API documentation for message automation and typing indicators for more details on usage and parameters.

Discussion