Prerequisites
- A Chatwork account
- API access enabled for your account
Getting Your API Key
- Sign in to your Chatwork account
- Go to your account settings
- Navigate to the “API” section
- Click “Generate API Key” or “Create new API key”
- Give your API key a descriptive name
- Copy the generated API key (you’ll only see it once)
API Key Permissions
When creating your API key, you can specify permissions:Read Permissions
- Read room information - Access room details and member lists
- Read messages - Access message history
- Read tasks - Access task information
Write Permissions
- Send messages - Send messages to rooms
- Create tasks - Create and manage tasks
- Manage room members - Add/remove room members
- Manage room settings - Update room information
Setting Up in Jinba Flow
- Go to your workspace settings in Jinba Flow
- Navigate to the “Secret” section
- Find “Chatwork” in the list of available credentials
- Click “Configure” or “Add New”
- Enter your Chatwork API key in the designated field
- Click “Save” to store your credentials
Usage
Once configured, you can use Chatwork in your flows to:- Send messages to rooms
- Read message history
- Create and manage tasks
- Get room information and member lists
- Upload files to rooms
- Manage room members and settings
API Endpoints
Messages
- Send text messages to rooms
- Send messages with file attachments
- Read message history
- Get message details
Rooms
- Get room information
- Get room member lists
- Create new rooms
- Update room settings
Tasks
- Create tasks in rooms
- Update task status
- Get task information
- Assign tasks to members
Files
- Upload files to rooms
- Get file information
- Download files