Stream Chat icon

Stream Chat

Server-side Stream Chat operations

Overview

The node performs server-side operations on Stream Chat messages, specifically allowing you to update an existing message. This is useful when you want to modify the content or other properties of a previously sent chat message in your application.

Common scenarios include:

  • Correcting typos or updating information in a chat message after it has been sent.
  • Adding additional context or details to a message without sending a new one.
  • Implementing message editing features in chat applications.

For example, you might use this node to update a message's text content by specifying the message ID and the new message data (such as updated text).

Properties

Name Meaning
Message Text The new text content for the message. Supports plain text and markdown. For rich content, use attachments or custom data fields instead. (Used in sendMessage and updateMessage operations)
Message ID The unique identifier of the message to update. This is required to specify which message to modify.
Message Data JSON object containing the message fields to update. For example, {"text": "Updated message"}. Allows updating various message properties beyond just text.

Output

The output contains a JSON object representing the updated message returned from the Stream Chat API. This typically includes the full message object with its updated fields such as id, text, timestamps, user info, and any other metadata.

If the operation fails, the output may contain an error message describing the issue.

The node does not output binary data.

Dependencies

  • Requires an API key credential for authenticating with the Stream Chat service.
  • The node uses the Stream Chat server-side client SDK to perform operations.
  • Proper permissions must be granted to the API credentials to allow message updates.

Troubleshooting

  • Missing or invalid Message ID: The operation requires a valid message ID. Ensure the ID corresponds to an existing message.
  • Invalid JSON in Message Data: The messageData property must be valid JSON. Syntax errors will cause failures.
  • Insufficient permissions: The API key used must have rights to update messages. Permission errors will occur otherwise.
  • Unsupported fields in messageData: Only supported message fields can be updated. Refer to Stream Chat API docs for allowed fields.
  • Network or API errors: Check connectivity and API limits if requests fail unexpectedly.

Error messages from the node will indicate the specific problem, often including the Stream Chat API error response.

Links and References

Discussion