zulip.json•11.3 kB
{
"nodeType": "n8n-nodes-base.zulip",
"displayName": "Zulip",
"description": "Consume Zulip API",
"version": 1,
"properties": [
{
"name": "to",
"displayName": "To",
"type": "multiOptions",
"default": [],
"description": "The destination stream, or a comma-separated list containing the usernames (emails) of the recipients. Choose from the list, or specify IDs using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
"required": true,
"displayOptions": {
"show": {
"resource": [
"message"
],
"operation": [
"sendPrivate"
]
}
}
},
{
"name": "content",
"displayName": "Content",
"type": "string",
"default": "",
"description": "The content of the message",
"required": true,
"displayOptions": {
"show": {
"resource": [
"message"
],
"operation": [
"sendPrivate"
]
}
}
},
{
"name": "stream",
"displayName": "Stream Name or ID",
"type": "options",
"default": "",
"description": "The destination stream, or a comma-separated list containing the usernames (emails) of the recipients. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
"required": true,
"displayOptions": {
"show": {
"resource": [
"message"
],
"operation": [
"sendStream"
]
}
}
},
{
"name": "topic",
"displayName": "Topic Name or ID",
"type": "options",
"default": "",
"description": "The topic of the message. Only required if type is stream, ignored otherwise. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
"required": true,
"displayOptions": {
"show": {
"resource": [
"message"
],
"operation": [
"sendStream"
]
}
}
},
{
"name": "messageId",
"displayName": "Message ID",
"type": "string",
"default": "",
"description": "Unique identifier for the message",
"required": true,
"displayOptions": {
"show": {
"resource": [
"message"
],
"operation": [
"update"
]
}
}
},
{
"name": "updateFields",
"displayName": "Update Fields",
"type": "collection",
"default": {},
"description": "The content of the message",
"placeholder": "Add Field",
"options": [
{
"name": "content",
"displayName": "Content",
"type": "string",
"default": "",
"description": "The content of the message"
}
],
"displayOptions": {
"show": {
"resource": [
"message"
],
"operation": [
"update"
]
}
}
},
{
"name": "dataBinaryProperty",
"displayName": "Put Output File in Field",
"type": "string",
"default": "data",
"required": true,
"displayOptions": {
"show": {
"resource": [
"message"
],
"operation": [
"updateFile"
]
}
}
},
{
"name": "operation",
"displayName": "Operation",
"type": "options",
"default": "sendPrivate",
"description": "Delete a message",
"options": [
{
"name": "Delete",
"value": "delete",
"description": "Delete a message"
},
{
"name": "Get",
"value": "get",
"description": "Get a message"
},
{
"name": "Send Private",
"value": "sendPrivate",
"description": "Send a private message"
},
{
"name": "Send to Stream",
"value": "sendStream",
"description": "Send a message to stream"
},
{
"name": "Update",
"value": "update",
"description": "Update a message"
},
{
"name": "Upload a File",
"value": "updateFile"
}
],
"displayOptions": {
"show": {
"resource": [
"message"
]
}
}
},
{
"name": "jsonParameters",
"displayName": "JSON Parameters",
"type": "boolean",
"default": false,
"displayOptions": {
"show": {
"resource": [
"stream"
],
"operation": [
"create"
]
}
}
},
{
"name": "additionalFieldsJson",
"displayName": "Additional Fields",
"type": "json",
"default": "",
"description": "JSON format parameters for stream creation",
"displayOptions": {
"show": {
"resource": [
"stream"
],
"operation": [
"create"
],
"jsonParameters": [
true
]
}
}
},
{
"name": "subscriptions",
"displayName": "Subscriptions",
"type": "fixedCollection",
"default": {},
"description": "A list of dictionaries containing the the key name and value specifying the name of the stream to subscribe. If the stream does not exist a new stream is created.",
"required": true,
"typeOptions": {
"multipleValues": true
},
"displayOptions": {
"show": {
"resource": [
"stream"
],
"operation": [
"create"
],
"jsonParameters": [
false
]
}
}
},
{
"name": "additionalFields",
"displayName": "Additional Fields",
"type": "collection",
"default": {},
"description": "If announce is True and one of the streams specified in subscriptions has to be created (i.e. doesnt exist to begin with), an announcement will be made notifying that a new stream was created.",
"placeholder": "Add Field",
"required": true,
"options": [
{
"name": "announce",
"displayName": "Announce",
"type": "boolean",
"default": false,
"description": "If announce is True and one of the streams specified in subscriptions has to be created (i.e. doesnt exist to begin with), an announcement will be made notifying that a new stream was created."
},
{
"name": "authorizationErrorsFatal",
"displayName": "Authorization Errors Fatal",
"type": "boolean",
"default": false,
"description": "Whether authorization errors (such as when the requesting user is not authorized to access a private stream) should be considered fatal or not. When True, an authorization error is reported as such. When set to False, the returned JSON payload indicates that there was an authorization error, but the response is still considered a successful one."
},
{
"name": "historyPublicToSubscribers",
"displayName": "History Public to Subscribers",
"type": "boolean",
"default": false,
"description": "Whether the streams message history should be available to newly subscribed members, or users can only access messages they actually received while subscribed to the stream"
},
{
"name": "inviteOnly",
"displayName": "Invite Only",
"type": "boolean",
"default": false,
"description": "Whether the streams specified in subscriptions are invite-only or not"
}
],
"typeOptions": {
"multipleValues": true
},
"displayOptions": {
"show": {
"resource": [
"stream"
],
"operation": [
"create"
],
"jsonParameters": [
false
]
}
}
},
{
"name": "streamId",
"displayName": "Stream ID",
"type": "string",
"default": "",
"description": "ID of stream to update",
"required": true,
"displayOptions": {
"show": {
"resource": [
"stream"
],
"operation": [
"update"
]
}
}
},
{
"name": "email",
"displayName": "Email",
"type": "string",
"default": "",
"description": "The email address of the new user",
"placeholder": "name@email.com",
"required": true,
"displayOptions": {
"show": {
"resource": [
"user"
],
"operation": [
"create"
]
}
}
},
{
"name": "fullName",
"displayName": "Full Name",
"type": "string",
"default": "",
"description": "The full name of the new user",
"required": true,
"displayOptions": {
"show": {
"resource": [
"user"
],
"operation": [
"create"
]
}
}
},
{
"name": "password",
"displayName": "Password",
"type": "string",
"default": "",
"description": "The password of the new user",
"required": true,
"displayOptions": {
"show": {
"resource": [
"user"
],
"operation": [
"create"
]
}
}
},
{
"name": "shortName",
"displayName": "Short Name",
"type": "string",
"default": "",
"description": "The short name of the new user. Not user-visible.",
"required": true,
"displayOptions": {
"show": {
"resource": [
"user"
],
"operation": [
"create"
]
}
}
},
{
"name": "userId",
"displayName": "User ID",
"type": "string",
"default": "",
"description": "The ID of user to get",
"required": true,
"displayOptions": {
"show": {
"resource": [
"user"
],
"operation": [
"get"
]
}
}
},
{
"name": "resource",
"displayName": "Resource",
"type": "options",
"default": "message",
"options": [
{
"name": "Message",
"value": "message"
},
{
"name": "Stream",
"value": "stream"
},
{
"name": "User",
"value": "user"
}
]
}
],
"credentialsConfig": [
{
"name": "zulipApi",
"required": true
},
{
"name": "resource",
"required": false
}
],
"io": {
"inputs": [],
"outputs": [],
"outputNames": [],
"hints": {}
},
"wiring": {
"role": "generic",
"requires": [],
"optional": [],
"consumedBy": [],
"consumes": [],
"produces": []
}
}