Zulip

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

Credentials

zulipApi (alias: @zulip)

CREDENTIAL @zulip = zulipApi "My Zulip"

Operations

Resource: message

delete

Parameter	Type	Default	Details
messageId	string	""	required

get

Parameter	Type	Default	Details
messageId	string	""	required

sendPrivate

Parameter	Type	Default	Details
to	multiOptions	[]	required
content	string	""	required

sendStream

Parameter	Type	Default	Details
stream	options	""	required
topic	options	""	required
content	string	""	required

update

Parameter	Type	Default	Details
messageId	string	""	required
updateFields	collection	{}	keys: content, propagateMode, topic

updateFile

Parameter	Type	Default	Details
dataBinaryProperty	string	"data"	required

Resource: stream

create

Parameter	Type	Default	Details
jsonParameters	boolean	false
additionalFieldsJson	json	""
subscriptions	fixedCollection	{}	required; groups: properties
additionalFields	collection	{}	keys: announce, authorizationErrorsFatal, historyPublicToSubscribers, inviteOnly, principals, streamPostPolicy

delete

Parameter	Type	Default	Details
streamId	string	""	required

getAll

Parameter	Type	Default	Details
additionalFields	collection	{}	keys: includeAllActive, includeDefault, includeOwnersubscribed, includePublic, includeSubscribed

getSubscribed

Parameter	Type	Default	Details
additionalFields	collection	{}	keys: includeSubscribers

update

Parameter	Type	Default	Details
streamId	string	""	required
jsonParameters	boolean	false
additionalFieldsJson	json	""
additionalFields	collection	{}	keys: isAnnouncementOnly, description, isPrivate, historyPublicToSubscribers, newName, streamPostPolicy

Resource: user

create

Parameter	Type	Default	Details
email	string	""	required
fullName	string	""	required
password	string	""	required
shortName	string	""	required

deactivate

Parameter	Type	Default	Details
userId	string	""	required

get

Parameter	Type	Default	Details
userId	string	""	required
additionalFields	collection	{}	keys: clientGravatar, includeCustomProfileFields

getAll

Parameter	Type	Default	Details
additionalFields	collection	{}	keys: clientGravatar, includeCustomProfileFields

update

Parameter	Type	Default	Details
userId	string	""	required
additionalFields	collection	{}	keys: fullName, isAdmin, isGuest, profileData, role

Parameter Details

updateFields children:

Parameter	Type	Default	Details
content	string	""
propagateMode	options	"changeOne"	changeOne, changeLater, changeAll
topic	string	""

subscriptions children:

properties group:

Parameter	Type	Default	Details
name	string	""	required
description	string	""	required

additionalFields children:

Parameter	Type	Default	Details
announce	boolean	false
authorizationErrorsFatal	boolean	false
historyPublicToSubscribers	boolean	false
inviteOnly	boolean	false
principals	fixedCollection	{}	groups: properties
streamPostPolicy	options	""	1, 2, 3

Example

NODE "zulip" @zulip AS "Zulip" {
  resource: "message",
  operation: "get",
  content: {{ $json.content }},
  messageId: {{ $json.messageId }},
  dataBinaryProperty: {{ $json.dataBinaryProperty }}
}