Skip to content

Mattermost

Node: mattermost · Full type: n8n-nodes-base.mattermost · Version: 1

Credentials

mattermostApi (alias: @mattermost)

CREDENTIAL @mattermost = mattermostApi "My Mattermost"

Operations

Resource: channel

addUser

Parameter Type Default Details
channelId options "" required
userId options "" required

create

Parameter Type Default Details
teamId options "" required
displayName string "" required
channel string "" required
type options "public" private, public

delete

Parameter Type Default Details
channelId options "" required

members

Parameter Type Default Details
teamId options "" required
channelId options "" required
resolveData boolean true
returnAll boolean true
limit number 100

restore

Parameter Type Default Details
channelId string "" required
Parameter Type Default Details
teamId options "" required
term string "" required
returnAll boolean false
limit number 100

statistics

Parameter Type Default Details
channelId options "" required

Resource: message

delete

Parameter Type Default Details
postId string "" required

post

Parameter Type Default Details
channelId options "" required
message string ""
attachments collection {} keys: actions, author_icon, author_link, author_name, color, fallback, ...
otherOptions collection {} keys: root_id

postEphemeral

Parameter Type Default Details
userId options "" required
channelId options "" required
message string ""

Resource: reaction

create

Parameter Type Default Details
userId options "" required
postId string "" required
emojiName string "" required

delete

Parameter Type Default Details
userId options "" required
postId string "" required
emojiName string "" required

getAll

Parameter Type Default Details
postId string "" required
returnAll boolean true
limit number 100

Resource: user

create

Parameter Type Default Details
username string "" required
authService options "" email, gitlab, google, ldap, office365, saml
authData string ""
email string ""
password string ""
additionalFields collection {} keys: first_name, last_name, locale, nickname, notificationUi

deactive

Parameter Type Default Details
userId string "" required

getByEmail

Parameter Type Default Details
email string "" required

getById

Parameter Type Default Details
userIds string "" required
additionalFields collection {} keys: since

getAll

Parameter Type Default Details
returnAll boolean true
limit number 100
additionalFields collection {} keys: inChannel, inTeam, notInTeam, notInChannel, sort

invite

Parameter Type Default Details
teamId options "" required
emails string "" required

Parameter Details

attachments children:

Parameter Type Default Details
actions fixedCollection {} groups: item
author_icon string ""
author_link string ""
author_name string ""
color color "#ff0000"
fallback string ""
fields fixedCollection {} groups: item
footer string ""
footer_icon string ""
image_url string ""
pretext string ""
text string ""
thumb_url string ""
title string ""
title_link string ""

otherOptions children:

Parameter Type Default Details
root_id string ""

additionalFields children:

Parameter Type Default Details
first_name string ""
last_name string ""
locale string ""
nickname string ""
notificationUi fixedCollection {} groups: notificationValues

Example

NODE "mattermost" @mattermost AS "Mattermost" {
  resource: "channel",
  operation: "post",
  displayName: {{ $json.displayName }},
  channel: {{ $json.channel }},
  term: {{ $json.term }}
}