| Active with remarks |
|---|
| This application needs additional settings. Please follow the documentation below to create your own connectionUnique, active service acces point to a network. There are different types of connections (API key, Oauth…).. |
With the Zulip modulesThe module is an application or tool within the Boost.space system. The entire system is built on this concept of modularity. (module - Contacts), you can do the following in your Zulip account.
To get started with the Zulip, create an account at zulip.com
![[Note]](https://docs.boost.space/wp-content/uploads/2022/11/note.png) |
Note |
|---|---|
| The moduleThe module is an application or tool within the Boost.space system. The entire system is built on this concept of modularity. (module - Contacts) dialog fields that are displayed in bold (in the Boost.spaceCentralization and synchronization platform, where you can organize and manage your data. IntegratorPart of the Boost.space system, where you can create your connections and automate your processes. scenarioA specific connection between applications in which data can be transferred. Two types of scenarios: active/inactive., not in this documentation article) are mandatory! |
To connect the Zulip app with the Boost.space Integrator:
- Log in to your Zulip account.
- Click Settings > Personal Settings.
- Click Bots > Add a New Bot. Enter the required details and click Create bot.
- Copy the Bot Email and API Key and store them in a safe place.
- Log in to your Boost.space Integrator and add a module from the Zulip into a Boost.space Integrator scenario.
- Click Add next to the Connection field.
- In the Connection name field, enter a name for the connection.
- In the Email, API Key, and Zulip Domain fields, enter the details copied in step 4 and click Save.
You have successfully connected the Zulip app with Boost.space Integrator and can now build scenariosA specific connection between applications in which data can be transferred. Two types of scenarios: active/inactive..
You can send messages, and upload files using the following modules.
Sends a stream or a private message.
Connection |
Establish a connection to your Zulip account. |
Type |
Select the message type:
|
Send to |
Select or map either the name or Integer ID of the stream to which you want to send the message. |
Topic |
Select or map the topic for which you want to send the message. |
Content |
Enter (map) the content of the message. The maximum message size is 10000 bytes. |
Uploads a file. To share the uploaded file, you’ll need to send a message containing the resulting link.
Connection |
Establish a connection to your Zulip account. |
File |
Enter( (map) the details of the file: |
Checks whether a set of messages matches a narrow.
Connection |
Establish a connection to your Zulip account. |
Message IDs |
Enter (map) a list of IDs whose messages you want to check. |
Narrow |
Select or map a structure defining the narrow to check against. |
You want to
Creates a new userCan use the system on a limited basis based on the rights assigned by the admin. account. The endpoint is only available to organization administrators.
Connection |
Establish a connection to your Zulip account. |
| Enter (map) the email address of the new user. | |
Password |
Enter (map) the password of the new user. |
Full Name |
Enter (map) the full name of the new user. |
Deactivates a user given their user ID. The endpoint is only available to organization administrators.
Connection |
Establish a connection to your Zulip account. |
User ID |
Select or map the User ID you want to deactivate. |
Reactivates a user given their user ID. This endpoint is only available to organization administrators.
Connection |
Establish a connection to your Zulip account. |
User ID |
Select or map a User ID you want to reactivate. |
Fetches details for a single user in the organization.
Connection |
Establish a connection to your Zulip account. |
User ID |
Select or map a User ID whose details you want to retrieve. |
Fetches details for a single user in the organization given a Zulip display email address.
Connection |
Establish a connection to your Zulip account. |
| Select or map the user’s email address whose details you want to retrieve. |
Retrieves details on all usersCan use the system on a limited basis based on the rights assigned by the admin. in the organization.
Connection |
Establish a connection to your Zulip account. |
Client Gravatar |
Select whether the client supports computing Gravatars URLs. The default value is true. |
Include Custom Profile Fields |
Select whether the client wants custom profile field data to be included in the response. The default value is false. |
Limit |
Set the maximum number of conversations Boost.space Integrator will return during one execution cycleA cycle is the operation and commit/rollback phases of scenario execution. A scenario may have one or more cycles (one is the default).. The default value is 10. |
You can call APIs using the following module.
Performs an arbitrary authorized API call.
Connection |
Establish a connection to your Zulip account. | |||
URL |
Enter a path relative to https://peoly.zulipchat.com/api/ . For example, /v1/users/me.
|
|||
Method |
GET to retrieve information for an entry.
to create a new entry.
to update/replace an existing entry.
to make a partial entry update.
to delete an entry. |
|||
Headers |
Enter the desired request headers. You don’t have to add authorization headers; we already did that for you. | |||
Query String |
Enter the request query string. | |||
Body |
Enter the body content for your API call. |
