Skip to main content
Chatwork logo
  • Category: team chat
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 30
  • Triggers: 0
  • Slug: CHATWORK
  • Version: 20261101_00

Tools

Slug: CHATWORK_CREATE_ROOMTool to create a new group chat room in Chatwork. Use when you need to set up a new collaborative space for team communication. This action allows you to specify room administrators, members with different permission levels (admin, regular, read-only), and optionally configure invitation links with custom access controls.

Input Parameters

Whether to create an invitation link for the room. Set to 1 to create a link, 0 to not create one. Default is 0.
string
required
Name of the chat room. Must be between 1 and 255 characters.
Custom code for the invitation link. If not specified, a random code will be generated when link is set to 1.
string
Description or overview of the chat room. Provides context about the room’s purpose.
string ("group" | "check" | "document" | "meeting" | "event" | "project" | "business" | "study" | "security" | "star" | "idea" | "heart" | "magcup" | "beer" | "music" | "sports" | "travel")
Enum for room icon presets.
string
required
Comma-separated list of account IDs to be designated as administrators of the room. At least one admin ID is required.
string
Comma-separated list of account IDs to be added as regular members of the room. These members can participate in conversations but have limited administrative rights.
Whether joining via the invitation link requires administrator approval. Set to 1 to require approval, 0 to allow direct joining. Default is 1.
string
Comma-separated list of account IDs to be added as read-only members. These members can view the room content but cannot post messages.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATWORK_CREATE_TASKTool to create a new task in a Chatwork room. Use when you need to assign tasks to users in a specific chat room. Requires the task description, assignee account IDs, and optionally a deadline timestamp.

Input Parameters

string
required
The content/description of the task
integer
Unix timestamp (in seconds) indicating the task deadline. If not specified, the task will have no deadline
string
required
Comma-separated list of account IDs to assign the task to. Multiple users can be assigned by separating IDs with commas (e.g., ‘1,3,6’)
integer
required
The ID of the chat room where the task will be created
string
Type of the limit. Currently only ‘time’ is supported. This field is optional and defaults to ‘time’ when a limit is specified

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATWORK_DELETE_MESSAGEThis tool allows you to delete a specific message from a Chatwork room by calling the DELETE endpoint at https://api.chatwork.com/v2/rooms/{room_id}/messages/{message_id}. It requires authentication using a Chatwork API token provided in the X-ChatWorkToken header, and the necessary permissions to delete messages in the specified room.

Input Parameters

string
required
The ID of the chat room containing the message to delete
string
required
The ID of the message to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATWORK_DELETE_ROOMTool to leave or delete a Chatwork room. When leaving, your tasks and files in the room are deleted. When deleting, all messages, tasks, and files in the room are permanently deleted. Use with caution as deletion is irreversible.

Input Parameters

string
required
The ID of the chat room to leave or delete
string ("leave" | "delete")
required
Type of action to perform. ‘leave’ to exit the room (your tasks and files are deleted), or ‘delete’ to permanently remove the entire room with all messages, tasks, and files. Requires appropriate permissions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATWORK_GET_CHATWORK_CONTACTSThis tool retrieves a list of all contacts from Chatwork. It is a fundamental tool that fetches all contact information such as account_id, room_id, name, chatwork_id, organization details, department, and avatar image URL, without needing additional parameters beyond authentication.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATWORK_GET_FILE2Tool to get information about a specific file in a chat room. Use when you need to retrieve file metadata including filename, size, upload time, and optionally a download URL.

Input Parameters

integer
required
The ID of the file to retrieve
integer
required
The ID of the chat room containing the file
integer
Whether to create a download URL. Set to 1 to create a download URL (valid for 30 seconds only). Defaults to 0.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATWORK_GET_INCOMING_REQUESTSTool to retrieve pending contact approval requests received by the authenticated user. Use when you need to check incoming connection requests from other users (up to 100 items).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATWORK_GET_METool to retrieve the authenticated user’s profile information including account details, organization, contact information, and avatar URL. Use when you need to get the current user’s complete profile data.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATWORK_GET_MESSAGETool to retrieve information about a specific message in a Chatwork room. Use when you need to get details about a particular message, including its content, sender, and timestamps.

Input Parameters

string
required
The ID of the chat room containing the message
string
required
The ID of the message to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATWORK_GET_MY_STATUSThis tool retrieves the current status of the authenticated user, including unread message counts and task status. It provides a quick overview of unread messages, mentions, and tasks, making it valuable for monitoring ChatWork activity and building automation workflows.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATWORK_GET_MY_TASKSTool to retrieve the authenticated user’s task list from Chatwork (up to 100 items). Use when you need to fetch tasks assigned to the user, with optional filtering by assigner or completion status.

Input Parameters

string ("open" | "done")
Enum for task completion status.
integer
Filter tasks by the account ID of the assigner. If specified, only returns tasks assigned by this account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATWORK_GET_ROOMRetrieves detailed information about a specific Chatwork room using the API endpoint GET /rooms/{room_id}. Returns comprehensive room details including name, icon, type, role, message/file/task counts, and other metadata. Useful for obtaining room-specific information when you already have the room ID.

Input Parameters

integer
required
The unique numeric identifier of the Chatwork room to retrieve. Can be obtained from the Get Rooms action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATWORK_GET_ROOM_FILESTool to get list of files in a chat room (up to 100 files). Use when you need to retrieve file information from a Chatwork room, optionally filtered by uploader.

Input Parameters

integer
required
The ID of the chat room to retrieve files from
integer
Filter files by the account ID that uploaded them. If not specified, returns files from all users.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATWORK_GET_ROOM_MEMBERSRetrieves a complete list of all members in a specified Chatwork room using the API endpoint GET /rooms/{room_id}/members. Returns detailed member information including account IDs, roles (admin/member/readonly), names, Chatwork IDs, organization details, departments, and avatar URLs. Useful for managing room permissions, generating member lists, and understanding room composition.

Input Parameters

integer
required
The unique numeric identifier of the Chatwork room to retrieve members from. Can be obtained from the Get Rooms action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATWORK_GET_ROOM_MESSAGES2Tool to retrieve messages from a Chatwork room (up to 100 messages). Use when you need to fetch chat history from a specific room. By default (force=0), returns only messages since the last retrieval. Set force=1 to get the latest 100 messages.

Input Parameters

integer
When set to 0 (default), returns only new messages since the last retrieval (incremental). When set to 1, forces retrieval of the latest 100 messages regardless of read status.
integer
required
The ID of the chat room to retrieve messages from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATWORK_GET_ROOMS2Tool to retrieve a list of all chat rooms the authenticated user belongs to. Use when you need to get information about all accessible rooms including group chats, direct messages, and personal chats.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATWORK_GET_ROOM_TASKSRetrieves a list of tasks from a Chatwork room. Returns up to 100 tasks. Use optional filters to narrow results by assignee, assigner, or completion status. Returns an empty list if there are no matching tasks.

Input Parameters

string ("open" | "done")
Enum for task completion status
integer
required
The ID of the chat room to retrieve tasks from
integer
Filter tasks by assignee account ID. If specified, only tasks assigned to this account are returned.
integer
Filter tasks by assigner account ID. If specified, only tasks assigned by this account are returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATWORK_GET_TASKRetrieves detailed information about a specific task in a Chatwork room using the API endpoint GET /rooms/{room_id}/tasks/{task_id}. Returns task details including assignee, creator, body, deadline, and completion status. Use this when you need to check the current state of a specific task or retrieve its full details.

Input Parameters

integer
required
The unique numeric identifier of the Chatwork room containing the task. Can be obtained from the Get Rooms action.
integer
required
The unique numeric identifier of the task to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATWORK_MARK_MESSAGES_READTool to mark messages as read in a Chatwork room. Use when you need to update the read status of messages up to a specific message ID. All messages up to and including the specified message will be marked as read.

Input Parameters

integer
required
The ID of the chat room where messages should be marked as read
string
required
The ID of the message to mark as read. All messages up to and including this message will be marked as read.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATWORK_MARK_MESSAGES_UNREADTool to mark messages as unread in a Chatwork room. Use when you need to mark a specific message and all subsequent messages as unread. This is useful for re-flagging important messages that need attention.

Input Parameters

integer
required
The ID of the chat room containing the message to mark as unread
string
required
The ID of the message to mark as unread. All messages after this message will be marked as unread.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATWORK_POST_MESSAGETool to post a new message to a Chatwork room. Use when you need to send a message to a specific chat room. Supports marking the message as unread for the sender via the self_unread parameter.

Input Parameters

string
required
The content of the message to post. Maximum length is 65535 characters, minimum length is 1 character.
string
required
The ID of the chat room to post the message to
integer
Whether to mark the posted message as unread for yourself. Specify 0 (default) for read, 1 for unread.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATWORK_UPDATE_MESSAGETool to update an existing message in a Chatwork room. Use when you need to modify the content of a previously sent message. Requires appropriate permissions to edit messages in the room.

Input Parameters

string
required
The new content for the message
string
required
The ID of the chat room containing the message to update
string
required
The ID of the message to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATWORK_UPDATE_ROOMTool to update chat room information (name, icon, description). Use when you need to modify existing chat room settings. At least one field (name, icon_preset, or description) must be provided.

Input Parameters

string
New name for the chat room
integer
required
Unique identifier for the room to update
string
New description/summary for the chat room
string ("group" | "check" | "document" | "meeting" | "event" | "project" | "business" | "study" | "security" | "star" | "idea" | "heart" | "magcup" | "beer" | "music" | "sports" | "travel")
Enum for available chat room icon presets.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATWORK_UPDATE_ROOM_MEMBERSUpdates the complete member list of a Chatwork room with bulk assignment of member roles (admin, member, readonly). This is a bulk update operation that replaces the entire member list - any existing members not included in the request will be removed from the room. At least one admin must be specified. Use this when reorganizing room permissions or changing multiple member roles at once.

Input Parameters

integer
required
The unique numeric identifier of the Chatwork room to update members in. Can be obtained from the Get Rooms action.
string
required
Comma-separated list of account IDs to assign admin privileges. At least one admin is required. Example: ‘123,456,789’
string
Comma-separated list of account IDs to assign member privileges. Members can read and write messages. Example: ‘21,344’
string
Comma-separated list of account IDs to assign read-only privileges. Read-only members can only view messages. Example: ‘15,103’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATWORK_UPDATE_TASK_STATUSTool to update the completion status of a task in a Chatwork room. Use when you need to mark a task as done or reopen a completed task. Requires appropriate permissions to modify tasks in the specified room.

Input Parameters

string ("open" | "done")
required
The completion status to set for the task. Use ‘done’ to mark as completed, ‘open’ to mark as incomplete.
integer
required
The ID of the chat room containing the task
integer
required
The ID of the task to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHATWORK_UPLOAD_FILEThis tool allows users to upload files to a specific Chatwork room. It enables file sharing functionality within the Chatwork platform by providing an endpoint to upload files (along with an optional message) to a given room.

Input Parameters

object
required
File to upload.
string
Optional message to accompany the file upload
string
required
The ID of the room where the file will be uploaded

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not