← Tools Reference

Rocket.Chat

Rocket.Chat integration (Communication, Productivity). Imported from open-connector.

Credentials form8 tools{base_url}
GET
rocket_chat_get_me
Get the authenticated Rocket.Chat profile.

/me

GET
rocket_chat_list_rooms
List Rocket.Chat rooms opened for the authenticated user.

/rooms.get

1 parameter
ParamTypeRequiredDescription
updatedSincestringoptionalOnly return room updates and removals since this ISO date-time.
GET
rocket_chat_get_room
Get metadata for one Rocket.Chat room by ID or name.

/rooms.info

3 parameters
ParamTypeRequiredDescription
roomIdstringoptionalThe room ID. Required if roomName is omitted.
roomNamestringoptionalThe room name. Required if roomId is omitted.
fieldsobjectoptionalRocket.Chat fields projection object. Use 1 to include and 0 to exclude each pr…
GET
rocket_chat_list_channel_messages
List messages in a Rocket.Chat public channel.

/channels.messages

7 parameters
ParamTypeRequiredDescription
roomIdstringrequiredThe public channel room ID.
countintegeroptionalThe number of messages to return.
offsetintegeroptionalThe number of messages to skip.
sortobjectoptionalRocket.Chat sort object. Use 1 for ascending and -1 for descending.
mentionIdsarrayoptionalUser IDs that must be mentioned by returned messages.
starredIdsarrayoptionalUser IDs that must have starred returned messages.
pinnedbooleanoptionalWhether to return only pinned messages.
GET
rocket_chat_get_message
Get one Rocket.Chat message by ID.

/chat.getMessage

1 parameter
ParamTypeRequiredDescription
msgIdstringoptionalThe message ID.
POST
rocket_chat_post_message
Post a message to a Rocket.Chat room, channel, or user target.

/chat.postMessage

9 parameters
ParamTypeRequiredDescription
roomIdstringrequiredThe room ID, channel name, or username target. Channel names must include the #…
textstringoptionalThe message text to send.
parseUrlsbooleanoptionalWhether Rocket.Chat should generate URL previews.
aliasstringoptionalDisplay alias for the message when the user has impersonation permission.
avatarstringoptionalAvatar URL for the message when the user has impersonation permission.
emojistringoptionalEmoji avatar for the message when the user has impersonation permission.
attachmentsarrayoptionalMessage attachments.
tmidstringoptionalThe original message ID for a thread reply.
customFieldsobjectoptionalCustom message fields configured by the workspace.
POST
rocket_chat_update_message
Update an existing Rocket.Chat message.

/chat.update

5 parameters
ParamTypeRequiredDescription
roomIdstringrequiredThe room ID where the message is located.
msgIdstringrequiredThe message ID to update.
textstringrequiredThe updated message text.
previewUrlsarrayoptionalURLs whose previews should be generated.
customFieldsobjectoptionalCustom message fields configured by the workspace.
POST
rocket_chat_delete_message
Delete an existing Rocket.Chat message.

/chat.delete

3 parameters
ParamTypeRequiredDescription
roomIdstringrequiredThe room ID where the message is located.
msgIdstringrequiredThe message ID to delete.
asUserbooleanoptionalWhether to delete as the user who sent the message.