Yoom Knowledge allows you to search for knowledge directly from Chatwork.
This article will show you how to set it up.
1. Issue a Chatwork account for Yoom Knowledge
Please create a new Chatwork account for Yoom Knowledge. By sending a message to this account, you will be able to search for knowledge in a chatbot-like format.
2. Set webhook URL in Chatwork
Log in to the Chatwork account for Yoom Knowledge that you issued earlier, and click "Service integration" from the person icon in the upper right.
Select "OAuth" from the left side menu.
The API usage application screen will be displayed, so please apply for usage.
An approval request will be sent to the Chatwork administrator, so please approve it.
Once approval is complete, open the "Service Integration" page again, select Webhook from the left side menu, and click the "Create New" button.
Please register the webhook name as "Yoom Knowledge" and set the webhook URL to " https://knowledge.yoom.fun/knowledge_linked_chat_apps/event_callback ".
For the event, select "Account Event" and click the "Create" button.
Once the settings are complete, a "Webhook Setting ID" and "Token" will be issued.
Copy this "Webhook Setting ID" and "Token" in order to register them in Yoom Knowledge.
*Tokens are extremely secure information, so please handle them with care.
3. Yoom Knowledge administrator connects Yoom Knowledge and Chatwork
If you are a Yoom Knowledge administrator, log in to Yoom Knowledge and click "Service Integrations" in the sidebar.
While logged in to the Chatwork account for Yoom Knowledge that you created earlier, click the "Link" button for Chatwork in the "Chat Tool Link" section to link Chatwork and Yoom Knowledge.
Click the "Allow" button.
Next, a webhook information registration screen will be displayed, so set the "Webhook setting ID" and "token" that you obtained when you registered the webhook earlier, and click the "Finish" button.
Please confirm that Chatwork has changed to "Integrated".
4. Employee registers Chatwork account ID in Yoom Knowledge
*This task must be performed by each user who searches from Chatwork.
If the Yoom Knowledge administrator links Yoom Knowledge and Chatwork as described above, other members will be able to link their Yoom Knowledge ID and Chatwork ID.
Click the "Link" button from Chatwork in the "Chat" section of "My Apps" on the settings page.
If you are a Yoom knowledge administrator, the button may already be labeled as linked. In that case, please cancel the link once and then click the "Link" button.
💡Before the administrator has linked Yoom Knowledge and Chatwork, the link button below will not be displayed
On the next screen, you will be asked to enter your Chatwork account ID, so enter your own account ID.
Please refer to this article for instructions on how to obtain your account ID .
Once you save it, it will become "linked" and you will be able to search for Yoom Knowledge information within Chatwork.
5.Search with mention in Chatwork
To actually search for knowledge within Chatwork, you need to mention the Chatwork account you created for Yoom Knowledge.
(Mentions are not required for 1-to-1 chats with Yoom Knowledge accounts.)
Also, if multiple knowledge bases exist, please search by adding the knowledge base ID at the beginning of the message{ナレッジベースID}:質問したい内容
in the format .
If there is only one knowledge base, there is no need to add the knowledge base ID at the beginning.
Please see this article for instructions on how to set up your knowledge base ID .
Also, when asking a question, you need to break the line after the mention.
| Result | Example |
With line break | The question text is recognized | [To:8750998] Yoom |
No line breaks | Question text not recognized | [To:8750998] Yoom Knowledge |
FAQ
Q. "Chat integration is not permitted." is displayed and I cannot enter my Chatwork account ID.
A. The administrator needs to link Chatwork and Yoom Knowledge in advance. Please ask your administrator to complete "2. Administrator can link Yoom Knowledge and Chatwork" in this article.
Q.Can I search by direct message with my Yoom Knowledge account?
Yes, you can also search by direct message with the Chatwork account you created for Yoom Knowledge.