Add Zulip node docs

This commit is contained in:
Tanay Pant
2020-07-13 15:41:57 +02:00
parent 2e25c2e7a7
commit dd6cfda4bc
3 changed files with 55 additions and 1 deletions

View File

@@ -11,7 +11,7 @@ Create a [Zulip](https://zulip.com/) account.
1. Access your Zulip dashboard.
2. Click on the gear icon on the top right.
3. Click on Settings.
4. Click on "Show/Change API Key".
4. Click on the *Show/change your API key* button under the API Key section.
5. Use your Zulip email, URL and the API token in your Zulip credentials.
![Getting Zulip credentials](./using-access-token.gif)

View File

@@ -0,0 +1,54 @@
---
permalink: /nodes/n8n-nodes-base.zulip
---
# Zulip
[Zulip](https://zulipchat.com/) is an open source chat and collaborative software. In Zulip, communication occurs in streams (which are like channels in IRC).
::: tip 🔑 Credentials
You can find authentication information for this node [here](../../../credentials/Zulip/README.md).
:::
## Basic Operations
- Message
- Delete a message
- Get a message
- Send a private message
- Send a message to stream
- Update a message
- Upload a file
- Stream
- Create a stream
- Delete a stream
- Get all streams
- Get subscribed streams
- Update a stream
- User
- Create a user
- Deactivate a user
- Get a user
- Get all users
- Update a user
## Example Usage
This workflow allows you to send a private message on Zulip. You can also find the [workflow](https://n8n.io/workflows/498) on the website. This example usage workflow would use the following two nodes.
- [Start](../../core-nodes/Start/README.md)
- [Zulip]()
The final workflow should look like the following image.
![A workflow with the Zulip node](./workflow.png)
### 1. Start node
The start node exists by default when you create a new workflow.
### 2. Zulip node
1. First of all, you'll have to enter credentials for the Zulip node. You can find out how to do that [here](../../../credentials/Zulip/README.md).
2. Select the user you want to send a private message to from the *To* dropdown list.
3. Type the message you want to post in the *Content* field.
4. Click on *Execute Node* to run the workflow.

Binary file not shown.

After

Width:  |  Height:  |  Size: 213 KiB