Chatwork

The Chatwork modules enable you to monitor events and manage room's tasks, contacts and rooms in your Chatwork account.

Getting Started with Chatwork

Prerequisites

  • A Chatwork account

In order to use Chatwork with Integromat, it is necessary to have a Chatwork account. If you do not have one, you can create a Chatwork account at chatwork.com.

The module dialog fields that are displayed in bold (in the Integromat scenario, not in this documentation article) are mandatory!

Connecting Chatwork to Integromat

1. Go to Integromat and open the Chatwork module's Create a connection dialog.

2. Enter a name for the connection to the Connection name field and click Continue.

fG4ZzD5Rim.gif

After you click the Continue button, Integromat will redirect you to the Chatwork website where you will be prompted to grant Integromat access to your account.

chrome_vcxu93iH6G.png

Confirm the dialog by clicking the Allow button.

Messages

List a Room's Messages

Retrieves all messages in a specified room.

ConnectionEstablish a connection to your Chatwork account.
Room IDSelect or enter (map) the ID of the room you want to list messages from.
LimitSet the maximum number of messages Integromat will return during one execution cycle.

Get a Room's Message

Retrieves message details.

ConnectionEstablish a connection to your Chatwork account.
Room IDSelect or enter (map) the ID of the room that contains the message you want to retrieve.
Message IDSelect or enter (map) the ID of the message you want to retrieve details for.

Create a Room Message

Creates a message in a specified room.

ConnectionEstablish a connection to your Chatwork account.
Room IDSelect or enter (map) the ID of the room you want to post a message to.
Message BodyEnter the message content.
Set the Message StatusSet the message you post as unread or read.

Tasks

List a Room's Tasks

Retrieves all tasks associated with a specified chat room.

ConnectionEstablish a connection to your Chatwork account.
Room IDSelect or enter (map) the ID of the room you want to retrieve tasks for.
Select or enter (map) the account ID of the person responsible for completing the task.
Filter by Task Assigner Account IDSelect or enter (map) the account ID of the person who assigned the task.
StatusSelect the status to filter returned tasks by.
LimitSet the maximum number of tasks Integromat will return during one execution cycle.

List My Tasks

Retrieves all tasks of an authenticated user.

ConnectionEstablish a connection to your Chatwork account.
Filter by Task Assigner Account IDSelect or enter (map) the account ID of the person who assigned the task.
StatusSelect the status to filter returned tasks by.
LimitSet the maximum number of tasks Integromat will return during one execution cycle.

Get a Room's Task

Retrieve task details.

ConnectionEstablish a connection to your Chatwork account.
Room IDSelect or enter (map) the ID of the room that contains the task you want to retrieve details for.
Select or enter (map) the task ID of the task you want to retrieve details for.

Create a Room Task

Creates a new task in a specified room.

ConnectionEstablish a connection to your Chatwork account.
Room IDSelect or enter (map) the ID of the room you want to create a task at.
Enter the task content.
Task AssigneesSelect or enter (map) the account ID of the person/people responsible for completing the task.
Task Due DateEnter the date and time when the task is due. The list of supported date and time formats.

Files

List a Room's Files

Returns a list of the files in a specified room.

ConnectionEstablish a connection to your Chatwork account.
Room IDSelect or enter (map) the ID of the room you want to retrieve files from.
Filter by Uploader Account IDSelect or enter (map) the account ID of the person who uploaded the file.
LimitSet the maximum number of files Integromat will return during one execution cycle.

Get a Room's File

Retrieves file details.

ConnectionEstablish a connection to your Chatwork account.
Room IDSelect or enter (map) the ID of the room that contains the file you want to retrieve details for.
Select or enter (map) the file ID of the file you want to retrieve details for.
Create Download URLSelect the Yes option to also return the download link in the module's output. Will be active for 30 seconds.

Contacts

List Contacts

Retrieves all contacts in your account.

ConnectionEstablish a connection to your Chatwork account.
LimitSet the maximum number of contacts Integromat will return during one execution cycle.

List my Contact Approval Requests

Retrieves all contact approval requests.

ConnectionEstablish a connection to your Chatwork account.
LimitSet the maximum number of approval requests Integromat will return during one execution cycle.

Approve a Contact Approval Request

Approves a contact approval request.

ConnectionEstablish a connection to your Chatwork account.
Request IDSelect or enter (map) the ID of the request you want to approve.

Decline a Contact Approval Request

Declines a contact approval request.

ConnectionEstablish a connection to your Chatwork account.
Request IDSelect or enter (map) the ID of the request you want to decline.

Rooms

List rooms

Retrieves all rooms in your account.

ConnectionEstablish a connection to your Chatwork account.
LimitSet the maximum number of rooms Integromat will return during one execution cycle.

Get a Room

Retrieves room details.

ConnectionEstablish a connection to your Chatwork account.
Room IDSelect or enter (map) the ID of the room that you want to retrieve details for.

Create a Groupchat

Creates a new group chat.

ConnectionEstablish a connection to your Chatwork account.
Group Chat NameEnter the title of the group chat.
Member Admin IDsSpecify group chat administrators.
Member Member IDsSpecify who will be given member permission for the group chat.
Member Read-Only IDsSpecify who will be given read-only permission for the group chat.
Group chat DescriptionEnter the description of the group chat.
Icon PresetSelect the type of group chat icon.

Update a Groupchat

Updates an existing group chat.

ConnectionEstablish a connection to your Chatwork account.
Room IDSelect or enter (map) the room ID of the group chat you want to update.
Group Chat NameEnter the title of the group chat.
Group chat DescriptionEnter the description of the group chat.
Icon PresetSelect the type of group chat icon.

Delete or Leave Groupchat

Deletes or leaves a group chat.

ConnectionEstablish a connection to your Chatwork account.
Leave or DeleteSelect whether you want to leave or delete the group chat.
Room IDSelect or enter (map) the ID of the room that you want to delete/leave.

List a Room's Members

Retrieves all members of a specified room.

ConnectionEstablish a connection to your Chatwork account.
Room IDSelect or enter (map) the ID of the room that you want to retrieve members from.
LimitSet the maximum number of members Integromat will return during one execution cycle.

Update a Groupchat's Members

Updates associated members of a group chat.

ConnectionEstablish a connection to your Chatwork account.
Room IDSelect or enter (map) the ID of the room you want to update members at.
Member Admin IDsSpecify group chat administrators.
Member Member IDsSpecify who will be given member permission for the group chat.
Member Read-Only IDsSpecify who will be given read-only permission for the group chat.

Other

Watch Events

Triggers when a message is created or updated, or when you are mentioned in the room.

The webhook URL needs to be generated in Integromat and then added to Chatwork's integrations settings.

1. Add the Watch Events module to your Integromat scenario.

2. Generate and copy the webhook URL.

lVWJcAlLlQ.gif

3. Log in to your Chatwork account.

4. Click on your account name in the top-right corner and select Integrations.

2020-10-29_16_23_55-.png

5. Go to Webhook > Create New.

NupEAeCdWS.gif

6. Fill the fields as follows:

Webhook nameEnter the name for the webhook.
Webhook URLEnter the webhook URL you have copied in step 2 (above).
EventSelect the event that will trigger the Watch Events module.

7. Click Create.

Now, every time the event occurs, the Watch Event module in your Integromat scenario is triggered.

To create a webhook secured with the token, follow these steps:

  1. Click on your account name in the top-right corner and select Integrations > Webhook > Create New.
  2. Fill in the parameters and use a random URL for the Webhook URL parameter; it does not matter right now. Click Create.
    At the bottom of the page you should see a Token. For example "Token": "IYS2YvleWo+qvttWyHNFDDa9rWw7x/dbWnYrAYKFUHc=" -> Copy it.
  3. Go to the Integromat -> Create a webhook with the Token parameter being the value you copied above (IYS2YvleWo+qvttWyHNFDDa9rWw7x/dbWnYrAYKFUHc=).
    Once the webhook is created, copy the Webhook URL Integromat provides.
  4. Go back to Chatwork > Integrations > Webhook. Find the webhook you have created and hit Edit.
    Paste the webhook URL the Integromat module provided into the Webhook URL field -> Save -> Done!

Make an API Call

Allows you to perform a custom API call.

ConnectionEstablish a connection to your Chatwork account.
URL

Enter a path relative to https://api.chatwork.com.
For example: /v2/rooms.

For the list of available endpoints, refer to the Chatwork API Documentation (PDF).
Method

Select the HTTP method you want to use:

GET
to retrieve information for an entry.

POST
to create a new entry.

PUT
to update/replace an existing entry.

PATCH
to make a partial entry update.

DELETE
to delete an entry.

HeadersEnter the desired request headers. You don't have to add authorization headers; we already did that for you.
Query StringEnter the request query string.
BodyEnter the body content for your API call.

Example of Use - List Messages

The following API call returns all messages in the specified room in your Chatwork account:

URL:
/v2/rooms/{room_id}/messages/

Method:
GET

Query String:
Key: force
Value: 1

2020-10-29_18_12_07-Integration_Chatwork___Integromat.png

The result can be found in the module's Output under Bundle > Body
In our example, 6 messages were returned:

2020-10-29_18_14_06-Integration_Chatwork___Integromat.png


Popular use cases from our blog

slack-automation-illustration

Slack Automation: 20 Free Templates to Get You Inspired

google-sheets-automation-alt

Google Sheets Automation for Ecommerce: 23 Free Templates

tweet-automation-illustration

How to Get Someone's Tweets Before Anyone Else Does

onboarding-automation-with-integromat-alt

How to Automate Employee Onboarding in Minutes with Integromat

shopify-order-to-manufacturer-illustration-alt

How to Auto Send Shopify Orders to Dropshipping Suppliers [Guide]

strava-exercise-to-google-sheets-illustration

Like a Champ: How to Save Strava Activities to Google Sheets

Didn’t find what you were looking for?

Ticket

Create a ticket

Contact our world-class support team and tell us what’s happening.

Create a ticket
Expert

Find an expert

We feature a network of 450+ certified partners across the globe who are ready to help

Find an expert

Automate any workflow in your business

Sign up for a free account today. No credit card required, no time limits on free plan.