kintone发生操作时发送的Webhook的通知内容

文章编号:040602

如启用Webhook，将从kintone 发送JSON格式的通知。
进行各项操作时，通知的参数如下：

添加记录/编辑记录/更新记录的状态

参数 值的类型 说明
id 字符串 分配给每个通知的唯一的ID。
type 字符串 操作的类型。
添加了记录：ADD_RECORD
编辑了记录：UPDATE_RECORD
更改了记录的状态：UPDATE_STATUS
app 对象 代表应用信息的对象。
app.id 文本框 应用的ID。
app.name 文本框 应用名称。
record 对象 代表记录信息的对象。
对象的格式与获取记录的REST API相同。
获取记录（GET）（cybozu developer network）
recordTitle 字符串 记录的标题。
可更改要设置为标题的字段。
设置记录标题
url 字符串 记录的URL。

发送通知的范例

{
"id":"01234567-0123-0123-0123-0123456789ab",
"type":"ADD_RECORD",
"app":{
"id":"1",
"name":"案件管理"
},
"record":{
"记录编号":{
"type":"RECORD_NUMBER",
"value":"2"
},
～～
"$revision":{
"type":"__REVISION__",
"value":"3"
},
"$id":{
"type":"__ID__",
"value":"2"
}
},
"recordTitle":"拜访：才望子",
"url":"https://example.cybozu.cn/k/1/show#record=2"
}

删除记录

参数 值的类型 说明
id 字符串 分配给每个通知的唯一的ID。
type 字符串 操作的类型。
删除了记录：DELETE_RECORD
app 对象 代表应用信息的对象。
app.id 文本框 应用的ID。
app.name 文本框 应用名称。
recordId 字符串 记录编号。不包含应用代码。
deleteBy 对象 代表删除记录的用户信息的对象。
deletedBy.code 文本框 用户的登录名。
deletedBy.name 文本框 用户的姓名。
deleteAt 字符串 删除的日期与时间。

发送通知的范例

{
"app":{
"id":"1",
"name":"案件管理"
},
"id":"01234567-0123-0123-0123-0123456789ab",
"recordId":"2",
"deleteBy":{
"code":"sato",
"name":"佐藤 升"
},
"deleteAt":"2017-07-03T09:38:09Z"
"type":"DELETE_RECORD"
}

填写回复

参数 值的类型 说明
app 对象 代表应用信息的对象。
app.id 文本框 应用的ID。
app.name 文本框 应用名称。
comment 对象 代表回复信息的对象。
对象的格式与批量获取记录回复的REST API相同。
批量获取记录的回复（cybozu developer network）
id 字符串 分配给每个通知的唯一的ID。
recordId 字符串 记录编号。不包含应用代码。
type 字符串 操作的类型。
填写了回复：ADD_RECORD_COMMENT
url 字符串 回复的URL。

发送通知的范例

{
"app":{
"id":"1",
"name":"案件管理"
},
"comment":{
"createdAt":"2012-02-03T09:38:09Z",
"creator":{
"code":"kato",
"name":"加藤 美咲"
},
"id":"11",
"mentions":[{
"code":"kato",
"type":"USER"
},{
"code":"org1",
"type":"ORGANIZATION"
},{
"code":"group1",
"type":"GROUP"
}],
"text":"我来拜访才望子了。""
},
"id":"01234567-0123-0123-0123-0123456789ab",
"recordId":"2",
"type":"ADD_RECORD_COMMENT",
"url":"https://example.cybozu.cn/k/1/show#record=2&comment=11"
}