| Active |
|---|
| This application does not need additional settings. So you can make connectionUnique, active service acces point to a network. There are different types of connections (API key, Oauth…). only by using your login credentials or by following the instructions below . |
The Chatwork modulesa module is an application or tool designed to handle specific business functions, such as CRM, project management, or inventory. The system's modular architecture allows you to activate only the modules you need, enabling customization and scalability as your business requirements evolve. enable you to monitor events and manage room’s tasks, contacts and rooms in your Chatwork account.
Prerequisites
-
A Chatwork account
In order to use Chatwork with Boost.spaceA platform that centralizes and synchronizes company data from internal and external sources, offering a suite of modules and addons for project management, CRM, data visualization, and more. Has many features to optimize your workflow! IntegratorPart of the Boost.space system, where you can create your connections and automate your processes., it is necessary to have a Chatwork account. If you do not have one, you can create a Chatwork account at chatwork.com.
![[Note]](https://docs.boost.space/wp-content/themes/bsdocs/docs-parser/HTML/css/image/note.png) |
Note |
|---|---|
|
The modulea module is an application or tool designed to handle specific business functions, such as CRM, project management, or inventory. The system's modular architecture allows you to activate only the modules you need, enabling customization and scalability as your business requirements evolve. dialog fields that are displayed in bold (in the Boost.space Integrator scenarioA specific connection between applications in which data can be transferred. Two types of scenarios: active/inactive., not in this documentation article) are mandatory! |
-
Go to Boost.space Integrator and open the Chatwork module’s Create a connection dialog.
-
Enter a name for the connection to the Connection name field and click Continue.
After you click the Continue button, Boost.space Integrator will redirect you to the Chatwork website where you will be prompted to grant Boost.space Integrator access to your account.
Confirm the dialog by clicking the Allow button.
Retrieves all messages in a specified room.
|
Connection |
|
|
Room ID |
Select or enter (map) the ID of the room you want to list messages from. |
|
Limit |
Set the maximum number of messages 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).. |
Retrieves message details.
|
Connection |
|
|
Room ID |
Select or enter (map) the ID of the room that contains the message you want to retrieve. |
|
Message ID |
Select or enter (map) the ID of the message you want to retrieve details for. |
Creates a message in a specified room.
|
Connection |
|
|
Room ID |
Select or enter (map) the ID of the room you want to post a message to. |
|
Message Body |
Enter the message content. |
|
Set the Message StatusIn Boost.space, statuses are indicators assigned to records within modules to represent their current state or progress. They can be system-defined, such as "Active" or "Done," or custom-created to fit specific workflows. Statuses help track and manage tasks, projects, and processes efficiently. |
Set the message you post as unread or read. |
Retrieves all tasks associated with a specified chat room.
|
Connection |
|
|
Room ID |
Select or enter (map) the ID of the room you want to retrieve tasks for. |
|
Filter by Task Assignee Account ID |
Select or enter (map) the account ID of the person responsible for completing the task. |
|
Filter by Task Assigner Account ID |
Select or enter (map) the account ID of the person who assigned the task. |
|
Status |
Select the status to filter returned tasks by. |
|
Limit |
Set the maximum number of tasks Boost.space Integrator will return during one execution cycle. |
Retrieves all tasks of an authenticated userCan use the system on a limited basis based on the rights assigned by the admin..
|
Connection |
|
|
Filter by Task Assigner Account ID |
Select or enter (map) the account ID of the person who assigned the task. |
|
Status |
Select the status to filter returned tasks by. |
|
Limit |
Set the maximum number of tasks Boost.space Integrator will return during one execution cycle. |
Retrieve task details.
|
Connection |
|
|
Room ID |
Select or enter (map) the ID of the room that contains the task you want to retrieve details for. |
|
Task ID |
Select or enter (map) the task ID of the task you want to retrieve details for. |
Creates a new task in a specified room.
|
Connection |
|
|
Room ID |
Select or enter (map) the ID of the room you want to create a task at. |
|
Task Description |
Enter the task content. |
|
Task Assignees |
Select or enter (map) the account ID of the person/people responsible for completing the task. |
|
Task Due Date |
Enter the date and time when the task is due. The list of supported date and time formats. |
Returns a list of the files in a specified room.
|
Connection |
|
|
Room ID |
Select or enter (map) the ID of the room you want to retrieve files from. |
|
Filter by Uploader Account ID |
Select or enter (map) the account ID of the person who uploaded the file. |
|
Limit |
Set the maximum number of files Boost.space Integrator will return during one execution cycle. |
Retrieves file details.
|
Connection |
|
|
Room ID |
Select or enter (map) the ID of the room that contains the file you want to retrieve details for. |
|
File ID |
Select or enter (map) the file ID of the file you want to retrieve details for. |
|
Create Download URL |
Select the Yes option to also return the download link in the module’s output. Will be active for 30 seconds. |
Retrieves all contacts in your account.
|
Connection |
|
|
Limit |
Set the maximum number of contacts Boost.space Integrator will return during one execution cycle. |
Retrieves all contact approval requests.
|
Connection |
|
|
Limit |
Set the maximum number of approval requests Boost.space Integrator will return during one execution cycle. |
Approves a contact approval request.
|
Connection |
|
|
Request ID |
Select or enter (map) the ID of the request you want to approve. |
Declines a contact approval request.
|
Connection |
|
|
Request ID |
Select or enter (map) the ID of the request you want to decline. |
Retrieves all rooms in your account.
|
Connection |
|
|
Limit |
Set the maximum number of rooms Boost.space Integrator will return during one execution cycle. |
Retrieves room details.
|
Connection |
|
|
Room ID |
Select or enter (map) the ID of the room that you want to retrieve details for. |
Creates a new group chat.
|
Connection |
|
|
Group Chat Name |
Enter the title of the group chat. |
|
MemberIn Boost.space, a Member is a role within a space that permits an individual to view and manage records using existing statuses and labels. Members cannot manage other members or modify space settings. AdminA user role in Boost.space with comprehensive system access, including the ability to add, remove, and manage all system levels. Admins can oversee all users, configure system settings, create custom fields, and manage modules and addons. Admin can also access Integrator and manage automations. IDs |
Specify group chat administrators. |
|
Member Member IDs |
Specify who will be given member permission for the group chat. |
|
Member Read-Only IDs |
Specify who will be given read-only permission for the group chat. |
|
Group chat Description |
Enter the description of the group chat. |
|
Icon Preset |
Select the type of group chat icon. |
Updates an existing group chat.
|
Connection |
|
|
Room ID |
Select or enter (map) the room ID of the group chat you want to update. |
|
Group Chat Name |
Enter the title of the group chat. |
|
Group chat Description |
Enter the description of the group chat. |
|
Icon Preset |
Select the type of group chat icon. |
Deletes or leaves a group chat.
|
Connection |
|
|
Leave or Delete |
Select whether you want to leave or delete the group chat. |
|
Room ID |
Select or enter (map) the ID of the room that you want to delete/leave. |
Retrieves all membersIn Boost.space, a Member is a role within a space that permits an individual to view and manage records using existing statuses and labels. Members cannot manage other members or modify space settings. of a specified room.
|
Connection |
|
|
Room ID |
Select or enter (map) the ID of the room that you want to retrieve members from. |
|
Limit |
Set the maximum number of members Boost.space Integrator will return during one execution cycle. |
Updates associated members of a group chat.
|
Connection |
|
|
Room ID |
Select or enter (map) the ID of the room you want to update members at. |
|
Member Admin IDs |
Specify group chat administrators. |
|
Member Member IDs |
Specify who will be given member permission for the group chat. |
|
Member Read-Only IDs |
Specify who will be given read-only permission for the group chat. |
TriggersThe initial event that starts a scenario. It can be an action, a scheduled time, or a custom event, and is essential to define at the beginning of each scenario. when a message is created or updated, or when you are mentioned in the room.
The webhookA webhook is a way for an app to send real-time information to a specific URL in response to certain events or triggers. URL needs to be generated in Boost.space Integrator and then added to Chatwork’s integrations settings.
-
Add the Watch Events module to your Boost.space Integrator scenario.
-
Generate and copy the webhook URL.
-
Log in to your Chatwork account.
-
Click on your account name in the top-right corner and select Integrations.
-
Go to Webhook > Create New.
-
Fill the fields as follows:
Webhook name
Enter the name for the webhook.
Webhook URL
Enter the webhook URL you have copied in step 2 (above).
Event
Select the event that will triggerThe initial event that starts a scenario. It can be an action, a scheduled time, or a custom event, and is essential to define at the beginning of each scenario. the Watch Events module.
-
Click Create.
Now, every time the event occurs, the Watch Event module in your Boost.space Integrator scenario is triggered.
To create a webhook secured with the tokenA secure code used to authenticate and authorize access to API endpoints, enabling users to connect with third-party applications., follow these steps:
-
Click on your account name in the top-right corner and select Integrations > Webhook > Create New.
-
Fill in the parameters and use a random URL for the Webhook URL parameter; it does not matter right now. Click Create. At the bottom of the page you should see a Token. For example “Token”: “IYS2YvleWo+qvttWyHNFDDa9rWw7x/dbWnYrAYKFUHc=” ->Copy it.
-
Go to the Boost.space Integrator -> Create a webhook with the Token parameter being the value you copied above (IYS2YvleWo+qvttWyHNFDDa9rWw7x/dbWnYrAYKFUHc=). Once the webhook is created, copy the Webhook URL Boost.space Integrator provides.
-
Go back to Chatwork > Integrations > Webhook. Find the webhook you have created and hit Edit. Paste the webhook URL the Boost.space Integrator module provided into the Webhook URL field -> Save -> Done!
Allows you to perform a custom API call.
|
Connection |
||||
|
URL |
Enter a path relative to
|
|||
|
Method |
Select the HTTP method you want to use: GET to retrieve information for an entry. POST to create a new entry. PUT to update/replace an existing entry. PATCH to make a partial entry update. DELETE 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. |
The following API call returns all messages in the specified room in your Chatwork account:
URL:
/v2/rooms/{room_id}/messages/
Method:
GET
Query String:
Key:force
Value: 1
 |
The result can be found in the module’s Output under BundleA bundle is a chunk of data and the basic unit for use with modules. A bundle consists of items, similar to how a bag may contain separate, individual items. > Body.
In our example, 6 messages were returned:
 |