Chatwork icon

Chatwork

Retrieve data from Chatwork API.

Overview

This node integrates with the Chatwork API to manage group chats (referred to as "rooms"). Specifically, for the "Rooms" resource and the "Create a new group chat" operation, it allows users to create a new group chat by specifying its name, description, icon type, and members with different permission levels. This is useful in scenarios where teams want to automate the creation of collaboration spaces for projects, events, or departments directly from workflows.

Practical examples include:

  • Automatically creating a project-specific group chat when a new project is initiated.
  • Setting up event-based group chats with predefined administrators and members.
  • Organizing team discussions by creating group chats with specific icons and descriptions to reflect their purpose.

Properties

Name Meaning
Group chat name Title of the group chat. Required field to name the new group chat.
Chat description Optional description providing more details about the group chat's purpose or topic.
Icon type Type of the group chat icon. Options include: group, check, document, meeting, event, project, business, study, security, star, idea, heart, magcup, beer, music, sports, travel.
Group Chat Administrators Comma-separated list of user IDs who will have administrator permissions in the group chat. At least one administrator must be specified.
Group Chat Members Comma-separated list of user IDs who will have member permissions in the group chat.
Group Chat Read-only Users Comma-separated list of user IDs who will have read-only permissions in the group chat.

Output

The output is a JSON object representing the newly created group chat returned by the Chatwork API. It typically includes details such as the group's ID, name, description, icon type, and lists of members with their roles. The node does not output binary data for this operation.

Dependencies

  • Requires an active connection to the Chatwork API using an API key credential configured in n8n.
  • The node depends on the Chatwork API endpoint for rooms (/rooms) with POST method to create new group chats.
  • Proper user IDs must be provided for administrators, members, and read-only users to successfully create the group chat.

Troubleshooting

  • Missing required fields: If the "Group chat name" or "Group Chat Administrators" are not provided, the API will reject the request. Ensure these fields are filled correctly.
  • Invalid user IDs: Providing invalid or non-existent user IDs in any of the members' lists may cause errors or unexpected behavior. Verify user IDs before use.
  • API authentication errors: If the API key credential is missing or invalid, the node will fail to authenticate. Check that the API key is correctly set up in n8n credentials.
  • Permission issues: The authenticated user must have sufficient permissions to create group chats and assign members. Lack of permissions will result in API errors.
  • Malformed input: Ensure that comma-separated user ID strings do not contain extra spaces or invalid characters.

Links and References

Discussion