Rocket.Chat

The rocket.chat modules allow you to create, update, list, retrieve. and delete the channels, private groups, and messages in your rocket.chat account.

Getting Started with Rocket Chat

Prerequisites

  • A rocket.chat account

In order to use rocket.chat with Integromat, it is necessary to have a rocket.chat account. If you do not have one, you can create a rocket .chat account at cloud.rocket.chat/trial.

The module dialog fields that are displayed in bold (in the Integromat scenario, not in this documentation article) are mandatory!

Connecting rocket.chat to Integromat

You can connect to rocket.chat using your username and password or with an auth code.

1. Go to Integromat and open the rocket.chat module's Create a connection dialog.

S7oQQOSOkh.gif

2. In the Connection name field, enter a name for the connection.

3. In the Workspace URL field, enter your rock.chat account's URL address. For example, https://integrodev.rocket.chat.

4. Select the Auth Type to establish the connection:

  • Username and Password
  • Auth Code

5. In the Username and Password fields, enter your rocket.chat credentials.

6. In the Auth Code field, enter the authentication code details. This field is required if two-factor via OTP is enabled. If you have installed rocket.chat on the cloud then the link to obtain the code is https://open.rocket.chat/accounts/security. You have to login to your account. If you have installed rocket.chat on your server, then the link to obtain the code is https://<domain_name>.rocket.chat/accounts/security.

iI5E0espQC.gif

7. Click Continue.

The connection has been established.

Channels

List Channels

Get a list of channels.

ConnectionEstablish a connection to your rocket.chat account.
LimitSet the maximum number of channels Integromat should return during one scenario execution cycle.

Get a Channel

Gets a channel.

ConnectionEstablish a connection to your rocket.chat account.
Identificator TypeSelect the option to choose the channel details:
  • Channel ID
  • Channel Name
Channel IDSelect the Channel ID whose details you want to retrieve.
Channel NameSelect the channel whose details you want to retrieve.

Create a Channel

Creates a new channel.

ConnectionEstablish a connection to your rocket.chat account.
Channel NameEnter a name for the channel.
Read OnlySelect whether the channel is read-only. The member can only view the messages but cannot send them.
MembersAdd the members to the channels by entering their usernames.

Rename a Channel

Renames a channel.

ConnectionEstablish a connection to your rocket.chat account.
Channel NameEnter a name for the channel.
New NameEnter a new name for the channel.

Delete a Channel

Deletes a channel.

ConnectionEstablish a connection to your rocket.chat account.
Identificator TypeSelect the option to choose the channel details:
  • Channel ID
  • Channel Name
Channel IDSelect the Channel ID you want to delete.
Channel NameSelect the channel name you want to delete.

Private Groups

List Private Groups

Gets a list of private groups.

ConnectionEstablish a connection to your rocket.chat account.
LimitSet the maximum number of private groups Integromat should return during one scenario execution cycle.

Get a Private Group

Gets a private group.

ConnectionEstablish a connection to your rocket.chat account.
Identificator TypeSelect the option to choose the private group details:
  • Private Group ID
  • Private Group Name
Private Group IDSelect the Private Group ID whose details you want to retrieve.
Private Group NameSelect the private group name whose details you want to retrieve.

Create a Private Group

Creates a new private group.

ConnectionEstablish a connection to your rocket.chat account.
Group Name

Enter a name for the group.

Read OnlySelect whether the group is read-only. The member can only view the messages but cannot send them.
MembersAdd the members to the channels by entering their usernames.

Rename a Private Group

Renames a private group.

ConnectionEstablish a connection to your rocket.chat account.
Group IDSelect the Group ID whose name you want to update.
New NameEnter a new name for the private group.

Delete a Private Group

Deletes a private group.

ConnectionEstablish a connection to your rocket.chat account.
Identificator TypeSelect the option to choose the private group details:
  • Private Group ID
  • Private Group Name
Private Group IDSelect the Private Group ID you want to delete.
Private Group NameSelect the group name you want to delete.

Messages

Send a Message

Post a new message to channel direct or a private group.

ConnectionEstablish a connection to your rocket.chat account.
Choose IDSelect the option to send the messages:
  • Generate Automatically
  • Write Own ID
Message ToSelect the option to which you want to send the message:
  • Channel
  • Private Group
  • Direct With
TM IDEnter the Message ID to create the thread.
Message TextEnter the message text which you want to send.
AliasEnter a message name to display when the message is received. 
Emoji IDEnter the Emoji ID to display along with the message text.
AvatarEnter the URL address sender's avatar in the message.
AttachmentsAdd the attachments to the message:
ColorEnter the color for the attachment. 
TextEnter the text to display for the attachment.
TsEnter the time to display next to the message text portion. For example, 2016-12-09T16:53:06.761Z
Thumb URLEnter the image URL address that appears next to the message text. 
Message LinkThis is only applicable if the ts is provided. Enter the URL address to make the time clickable to this link.
CollapsedSelect the checkbox to hide the image, audio, and video files.
Author NameEnter the name of the attachment author.
Author LinkEnter the URL address to make the author name clickable and points to this link.
Author IconEnter the URL address to the image that appears on the left side of the message text.
TitleEnter a name for the attachment.
Title Link Enter the URL address to make the message name clickable. For example, www.youtube.com
Title Link DownloadSelect the checkbox if you want to provide a download icon in the message.
Image URLEnter the URL address to the image which you want to send with the message.
Audio URLEnter the URL address to the audio file which you want to send with the message.
Video URLEnter the URL address to the video file which you want to send with the message.
Fields

Add the fields:

Short

Select whether it is a short field.

Title

Enter a name for the field.

Value

Enter the value of the field.

Other

Make an API Call

Performs an arbitrary authorized API call.

ConnectionEstablish a connection to your rocket.chat account.
URL

Enter a path relative to https://your-workspace-url.com/api. For example: /v1/rooms.get

For the list of available endpoints, refer to the rocket.chat API Documentation.
Method

Select the HTTP method you want to use:

GET
to retrieve information for an entry.

POST
to create a new entry.

PUT
to update/replace an existing entry.

PATCH
to make a partial entry update.

DELETE
to delete an entry.

HeadersEnter the desired request headers. You don't have to add authorization headers; we already did that for you.
Query StringEnter the request query string.
BodyEnter the body content for your API call.

Example of Use - List Private Groups

The following API call returns all the groups from your rocket.chat account:

URL:
/v1/groups.list

Method:
GET

rocketchat2.png

Matches of the search can be found in the module's Output under BundleBody > groups
In our example, 3 groups were returned:

rocketchat1.png


Popular use cases from our blog

slack-automation-illustration

Slack Automation: 20 Free Templates to Get You Inspired

google-sheets-automation-alt

Google Sheets Automation for Ecommerce: 23 Free Templates

tweet-automation-illustration

How to Get Someone's Tweets Before Anyone Else Does

onboarding-automation-with-integromat-alt

How to Automate Employee Onboarding in Minutes with Integromat

shopify-order-to-manufacturer-illustration-alt

How to Auto Send Shopify Orders to Dropshipping Suppliers [Guide]

strava-exercise-to-google-sheets-illustration

Like a Champ: How to Save Strava Activities to Google Sheets

Didn’t find what you were looking for?

Ticket

Create a ticket

Contact our world-class support team and tell us what’s happening.

Create a ticket
Expert

Find an expert

We feature a network of 450+ certified partners across the globe who are ready to help

Find an expert

Automate any workflow in your business

Sign up for a free account today. No credit card required, no time limits on free plan.