Chatwork icon

Chatwork

Retrieve data from Chatwork API.

Overview

This node integrates with the Chatwork API to retrieve and manipulate chatroom-related data. Specifically, for the Rooms - Get detail operation, it fetches detailed information about a specific chatroom by its ID. This is useful in scenarios where you need to obtain metadata or configuration details of a chatroom, such as its name, description, members, or settings.

Practical examples include:

  • Displaying chatroom details in a dashboard.
  • Using chatroom info to trigger workflows based on room properties.
  • Auditing or logging chatroom configurations.

Properties

Name Meaning
Chatroom ID The unique numeric identifier of the chatroom whose details you want to retrieve.

Output

The output JSON contains the detailed information of the specified chatroom. This typically includes fields such as the chatroom's ID, name, description, icon preset, member lists (admins, members, readonly), and other metadata provided by the Chatwork API.

No binary data output is involved in this operation.

Example output structure (simplified):

{
  "room_id": 92107487,
  "name": "Project Alpha",
  "description": "Chatroom for Project Alpha discussions",
  "icon_preset": "group",
  "members_admin_ids": [12345, 67890],
  "members_member_ids": [11111, 22222],
  "members_readonly_ids": [33333]
}

Dependencies

  • Requires an active connection to the Chatwork API using an API key credential configured in n8n.
  • The node uses HTTP requests to communicate with Chatwork endpoints.
  • No additional external dependencies beyond the Chatwork API and proper authentication.

Troubleshooting

  • Common issues:

    • Invalid or missing Chatroom ID: Ensure the Chatroom ID is correct and exists.
    • Authentication errors: Verify that the API key credential is valid and has sufficient permissions.
    • Network or API downtime: Check network connectivity and Chatwork service status.
  • Error messages:

    • "operation is not supported." — This indicates an unsupported operation was requested; verify the operation parameter.
    • "resource is not supported." — Indicates an invalid resource selection; ensure "Rooms" is selected.
    • HTTP errors from the API (e.g., 404 Not Found) usually mean the chatroom does not exist or access is denied.

Resolving these typically involves verifying input parameters, credentials, and network conditions.

Links and References

Discussion