ByteChef LogoByteChef

Mattermost

Mattermost is an open-source, self-hosted messaging platform designed for secure team collaboration and communication.

Categories: Communication

Type: mattermost/v1


Connections

Version: 1

Bearer Token

Properties

NameLabelTypeDescriptionRequired
domainDomainSTRINGtrue
tokenTokenSTRINGtrue

Connection Setup

  1. Go to System Console.
  2. Scroll to INTEGRATIONS and click on Integration Management.
  3. Scroll to Enable Personal Access Tokens and click true.
  4. In System Console find USER MANAGEMENT and click on Users.
  5. Identify the account you want to create a personal access token with. By default, only System Admins have permissions to create a personal access token. To create an access token with a non-admin account, you must first give it the appropriate permissions. Find the user account, then select Manage Roles from the dropdown.
  6. Select Allow this account to generate personal access tokens and post:all and then click Save.
  7. Go back to your profile and go to Account Settings.
  8. Go to Security and under Personal Access Token click Edit.
  9. Select Create Token.
  10. Enter a description for the token and then select Save.
  11. Copy the access token and use it in ByteChef.

Actions

Send message

Name: sendMessage

Send message to a channel.

Properties

NameLabelTypeDescriptionRequired
channel_idChannel IdSTRINGThe channel ID to send message to.true
messageMessageSTRINGThe message contents.true

Example JSON Structure

{
  "label" : "Send message",
  "name" : "sendMessage",
  "parameters" : {
    "channel_id" : "",
    "message" : ""
  },
  "type" : "mattermost/v1/sendMessage"
}

Output

Type: OBJECT

Properties

NameTypeDescription
idSTRINGID of the message.
create_atINTEGERThe time in milliseconds a post was created.
update_atINTEGERThe time in milliseconds a post was last updated.
edit_atINTEGERThe time in milliseconds a post was last edited.
delete_atINTEGERThe time in milliseconds a post was deleted.
is_pinnedBOOLEAN
Options true, false
True if post is pinned to the channel it is in.
user_idSTRINGID of the user.
channel_idSTRINGID of the channel.
root_idSTRINGPost ID if post is created as a comment on another post.
parent_idSTRING
original_idSTRING
messageSTRINGThe actual content of the message.
typeSTRING
propsOBJECT
Properties {}
hashtagsSTRINGAny hashtags included in the message content.
pending_post_idSTRING
reply_countINTEGERNumber of replies to this message.
last_reply_atINTEGERThe time in milliseconds of the most recent reply.
participantsOBJECT
Properties {}
is_followingBOOLEAN
Options true, false
metadataOBJECT
Properties {[{STRING(type), STRING(url), {}(data)}](embeds), [{STRING(id), STRING(creator_id), STRING(name), INTEGER(create_at), INTEGER(update_at), INTEGER(delete_at)}](emojis), [{STRING(id), STRING(user_id), STRING(post_id), INTEGER(create_at), INTEGER(update_at), INTEGER(delete_at), STRING(name), STRING(extension), INTEGER(size), STRING(mime_type), INTEGER(width), INTEGER(height), BOOLEAN(has_preview_image)}](files), [{INTEGER(height), INTEGER(width)}](images), [{STRING(user_id), STRING(post_id), STRING(emoji_name), INTEGER(create_at)}](reactions)}
Additional information used to display the post.

Output Example

{
  "id" : "",
  "create_at" : 1,
  "update_at" : 1,
  "edit_at" : 1,
  "delete_at" : 1,
  "is_pinned" : false,
  "user_id" : "",
  "channel_id" : "",
  "root_id" : "",
  "parent_id" : "",
  "original_id" : "",
  "message" : "",
  "type" : "",
  "props" : { },
  "hashtags" : "",
  "pending_post_id" : "",
  "reply_count" : 1,
  "last_reply_at" : 1,
  "participants" : { },
  "is_following" : false,
  "metadata" : {
    "embeds" : [ {
      "type" : "",
      "url" : "",
      "data" : { }
    } ],
    "emojis" : [ {
      "id" : "",
      "creator_id" : "",
      "name" : "",
      "create_at" : 1,
      "update_at" : 1,
      "delete_at" : 1
    } ],
    "files" : [ {
      "id" : "",
      "user_id" : "",
      "post_id" : "",
      "create_at" : 1,
      "update_at" : 1,
      "delete_at" : 1,
      "name" : "",
      "extension" : "",
      "size" : 1,
      "mime_type" : "",
      "width" : 1,
      "height" : 1,
      "has_preview_image" : false
    } ],
    "images" : [ {
      "height" : 1,
      "width" : 1
    } ],
    "reactions" : [ {
      "user_id" : "",
      "post_id" : "",
      "emoji_name" : "",
      "create_at" : 1
    } ]
  }
}

How is this guide?

Last updated on

On this page