To strengthen security, our custom message push service (Webhooks) now only supports domain names or IP addresses that can be pushed to your internal network (intranet). Please note that all public domain name push services that you previously used will stop working on April 1, 2024. We strongly recommend updating as early as possible to avoid service disruptions. For more information about the seven-network isolation policy, please refer to the related document: Seven Network Isolation. |
By configuring a knowledge base or a team's webhooks, developers can be automatically notified when a document changes.
⚠️ Knowledge Base If the "Auto-Publish" function is configured, the update/push operation of the document will not send a webhook notification temporarily.
On the Knowledge Base -> Settings -> Developer Settings page, the Webhooks configuration address will appear.
HTTPS://YUQUE.ANTFIN.COM/FORCES/HOW-WE-BUILD-YUQUE/SETTINGS/WEBHOOKS
语雀产品架构之美 The beauty of Yuque's product architecture
权限 Permissions
设置 Set up
回收站 recycle bin
统计 statistics
设置 Set up
知识库信息 Knowledge base information
新增消息推送 Added message push
高级设置 Advanced settings
推送到 Push to
其他渠道 Other channels
钉钉群 DingTalk group
消息推送 Push messages
可将知识库内动态推送到其他渠道,相关信息并填写到下方查看获取方式
You can dynamically push the knowledge base to other channels, and fill in the relevant information below to view the way to obtain it
You can dynamically push the knowledge base to other channels, and fill in the relevant information below to view the way to obtain it
机器人名字 Robot name
名称,如钉钉机器人 Name, such as DingTalk Robot
WEBHOOK 地址 WEBHOOK ADDRESS
URL
当知识库内发生以下动态时推送 Push when the following dynamics occur in the knowledge base
发布文档 Publish the document
新增评论 Add a comment
更新文档 Update the documentation
更新评论 Update the review
发起评审 Initiate a review
评审完成 The review is complete
取消评审 Cancel the review
添加 Add to
To add a webhook to your entire team's documents, you can set it up on the team settings page:
HTTPS://YUQUE.ANTFIN.COM/FORCES/SETTINGS/WEBHOOKS
消息推送 Push messages
添加 Add to
智能协同事业部 Intelligent Collaboration Division
团队管理 Team management
推送条件 Push conditions
名字 name
WEBHOOK 地址 WEBHOOK ADDRESS
操作 operate
统计 statistics
发布文档 Publish the document
更新文档 Update the documentation
权限 Permissions
RFC小 The RFC is small
HTTPS://OAPI.DINGTALK.COM/ROBOT/SEND?
测试 Test
删除 Delete
编辑 edit
发起评审 Initiate a review
ACCESS_TOKEN-E613DBD680EBA9FBC29A7D0...
助手 aides
评审完成 The review is complete
安全日志 Security logs
取消评审 Cancel the review
消息推送 Push messages
TOKEN
回收站 recycle bin
设置 Set up
If the added Webhooks URL is the address of the DingTalk custom bot, the document of the knowledge base will be published and updated to the bot in the DingTalk link message format. Since DingTalk has enabled the security settings of the robot, you need to add "Yuque" to the "Custom Keywords".
添加机器人 Add a bot
机器人名字: Robot Name:
日报周报语雀机器人 Daily Weekly Newspaper Whispering Sparrow Robot
蚂蚁体验技术部 Ant Experience Technology Department
添加到群组: Add to a group:
安全设置 Security settings
自定义关键词 Custom keywords
说明文档 Documentation
语雀 Whispering Sparrow
添加 Add to
(最多添加10个) (Add up to 10)
我已阅读并同意 I have read and agreed
定义机器人服务及免毒 Define bot services and toxicity immunity
款
完成 finish
取消 Cancel
配置截图 Screenshot of the configuration
钉钉上显示效果 DingTalk shows the effect
In a Yuque document, you can set a custom tag, and when the document-related information is pushed to the DingTalk group, the tagname will also be sent. In this way, you can filter and only receive messages containing specific tags through the "Custom Keywords" function in the "Security Settings" of the DingTalk group bot, so as to obtain the information you need conveniently and quickly.
TAGS:#技术##产品文档##测试#
文中提及:小明,大王 The text mentions: Xiao Ming, the king
第二行内容 The second line reads
语雀消息 Whispering Bird Message
正文内容 Body content
AG定制推送 AG custom push
白机器人 White robots
请保管好此WEBHOOK地址,不要公布在外部网站上,泄露有安全风险
PLEASE KEEP THIS WEBHOOK ADDRESS SAFE AND DO NOT PUBLISH IT ON EXTERNAL WEBSITES, AS IT MAY BE LEAKED DUE TO SECURITY RISKS
PLEASE KEEP THIS WEBHOOK ADDRESS SAFE AND DO NOT PUBLISH IT ON EXTERNAL WEBSITES, AS IT MAY BE LEAKED DUE TO SECURITY RISKS
使用WEBHOOK地址,向钉钉群推送消息查看文档 USE THE WEBHOOK ADDRESS TO PUSH MESSAGES TO THE DINGTALK GROUP TO VIEW DOCUMENTS
HTTPS://OAPI.DINGTALK.COM/ROBOT/SEND?AC
9添加(最多添加10个) 9 additions (up to 10 additions)
机器人管理 Bot management
自定义关键词 Custom keywords
安全设置 Security settings
IP地址(段) IP address (range)
#产品文档#
WEBHOOK:
#技术#
说明文档 Documentation
取消 Cancel
重置 reset
完成 finish
加签 Apostille
复制 copy
When the document changes, Yuque will automatically use HTTP POST to request the configured webhook URL, the specific body is a JSON data structure, the example is as follows:
POST http://someone.com/yuque/webhook
{
"data": DataSerializer
}
The address corresponding to the webhook needs to be interoperable with Yuque's server, that is, the URL required to be filled in must be an intranet domain name or IP, and the group needs to apply for a cross-domain VIP.
The deserialized JSON of the table body field looks like this:
6 likes
6
