Configure your Chatwork API credentials to send messages, manage rooms, and interact with Chatwork from your Jinba Flow workflows.

Prerequisites

  • A Chatwork account
  • API access enabled for your account

Getting Your API Key

  1. Sign in to your Chatwork account
  2. Go to your account settings
  3. Navigate to the “API” section
  4. Click “Generate API Key” or “Create new API key”
  5. Give your API key a descriptive name
  6. 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

  1. Go to your workspace settings in Jinba Flow
  2. Navigate to the “Secret” section
  3. Find “Chatwork” in the list of available credentials
  4. Click “Configure” or “Add New”
  5. Enter your Chatwork API key in the designated field
  6. 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