Skip to content

Discord

Node: discord · Full type: n8n-nodes-base.discord · Version: 2

Credentials

discordBotApi (alias: @discord) / discordOAuth2Api (alias: @discord) / discordWebhookApi (alias: @discord)

CREDENTIAL @discord = discordBotApi "My Discord"

Operations

Resource: channel

create

Parameter Type Default Details
name string "" required
type options "0" required; 0, 2, 4
options collection {} keys: nsfw, bitrate, categoryId, position, rate_limit_per_user, topic, ...

deleteChannel

Parameter Type Default Details
channelId resourceLocator {...} required; modes: list, url, id

get

Parameter Type Default Details
channelId resourceLocator {...} required; modes: list, url, id

getAll

Parameter Type Default Details
returnAll boolean false
limit number 100
options collection {} keys: filter

update

Parameter Type Default Details
channelId resourceLocator {...} required; modes: list, url, id
name string ""
options collection {} keys: nsfw, bitrate, categoryId, position, rate_limit_per_user, topic, ...

Resource: message

deleteMessage

Parameter Type Default Details
channelId resourceLocator {...} required; modes: list, url, id
messageId string "" required

get

Parameter Type Default Details
channelId resourceLocator {...} required; modes: list, url, id
messageId string "" required
options collection {} keys: simplify

getAll

Parameter Type Default Details
channelId resourceLocator {...} required; modes: list, url, id
returnAll boolean false
limit number 100
options collection {} keys: simplify

react

Parameter Type Default Details
channelId resourceLocator {...} required; modes: list, url, id
messageId string "" required
emoji string "" required

send

Parameter Type Default Details
sendTo options "channel" user, channel
userId resourceLocator {...} modes: list, id
channelId resourceLocator {...} required; modes: list, url, id
content string ""
options collection {} keys: flags, message_reference, tts
embeds fixedCollection [] groups: values
files fixedCollection [] groups: values

sendAndWait

Parameter Type Default Details
sendTo options "channel" user, channel
userId resourceLocator {...} modes: list, id
channelId resourceLocator {...} required; modes: list, url, id
message string "" required
responseType options "approval" approval, freeText, customForm
defineForm options "fields" fields, json
jsonOutput json "[
{
"fieldLabel": "Name",
"..."
formFields fixedCollection {} groups: values
formFields fixedCollection {} groups: values
approvalOptions fixedCollection {} groups: values
options collection {} keys: limitWaitTime, appendAttribution
options collection {} keys: messageButtonLabel, responseFormTitle, responseFormDescription, responseFormButtonLabel, responseFormCustomCss, limitWaitTime, ...

Resource: member

getAll

Parameter Type Default Details
returnAll boolean false
limit number 100
after string ""
options collection {} keys: simplify

roleAdd

Parameter Type Default Details
userId resourceLocator {...} modes: list, id
role multiOptions [] required

roleRemove

Parameter Type Default Details
userId resourceLocator {...} modes: list, id
role multiOptions [] required

Common Parameters

Parameter Type Default Details
authentication options "botToken" botToken, oAuth2, webhook
guildId resourceLocator {...} required; modes: list, url, id

Parameter Details

options children:

Parameter Type Default Details
simplify boolean true

embeds children:

values group:

Parameter Type Default Details
inputMethod options "fields" fields, json
json json "={}"
description string ""
author string ""
color color ""
timestamp dateTime ""
title string ""
url string ""
image string ""
thumbnail string ""
video string ""

files children:

values group:

Parameter Type Default Details
inputFieldName string "data"

formFields children:

values group:

Parameter Type Default Details
fieldName string "" required
fieldLabel string "" required
fieldLabel string "" required
fieldName string ""
fieldType options "text" required; checkbox, html, date, dropdown, email, file, hiddenField, number, ... (12 total)
elementName string ""
fieldName string ""
placeholder string ""
defaultValue string ""
defaultValue dateTime ""
defaultValue string ""
defaultValue string ""
fieldValue string ""
fieldOptions fixedCollection {...} required; groups: values
fieldOptions fixedCollection {...} required; groups: values
fieldOptions fixedCollection {...} required; groups: values
multiselect boolean false
limitSelection options "unlimited" exact, range, unlimited
numberOfSelections number 1
minSelections number 0
maxSelections number 1
html string "

" | | | multipleFiles | boolean | true | | | acceptFileTypes | string | "" | | | requiredField | boolean | false | |

approvalOptions children:

values group:

Parameter Type Default Details
approvalType options "single" single, double
approveLabel string "✓ Approve"
disapproveLabel string "✗ Decline"

Example

NODE "discord" @discord AS "Discord" {
  resource: "channel",
  operation: "get",
  messageId: {{ $json.messageId }},
  emoji: {{ $json.emoji }},
  message: {{ $json.message }}
}