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

記事番号:040602

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

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

参数数据类型 说明
id字符串 分配给每个通知的唯一的ID。
type字符串

操作的类型。
添加了记录:ADD_RECORD
编辑了记录:UPDATE_RECORD
更改了记录的状态:UPDATE_STATUS

app对象 代表应用信息的对象。
app.id字符串 アプリのIDです。
app.name字符串 アプリ名です。
record对象

代表记录信息的对象。
对象的格式与获取记录的REST API相同。
获取1条记录

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":"拜访:Cybozu, Inc.",
"url":"https://example.cybozu.com/k/1/show#record=2"
}

レコードの削除

参数数据类型 说明
id字符串 分配给每个通知的唯一的ID。
type字符串

操作的类型。
删除了记录:DELETE_RECORD

app对象 代表应用信息的对象。
app.id字符串 アプリのIDです。
app.name字符串 アプリ名です。
recordId字符串 记录编号。不包含应用代码。
deletedBy对象 代表删除记录的用户信息的对象。
deletedBy.code字符串 ユーザーのログイン名です。
deletedBy.name字符串 用户的姓名。
deletedAt字符串 删除的日期与时间。

发送通知的范例

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

コメントの書き込み

参数数据类型 说明
app对象 代表应用信息的对象。
app.id字符串 アプリのIDです。
app.name字符串 アプリ名です。
comment对象

代表回复信息的对象。
对象的格式与批量获取记录回复的REST API相同。
获取记录的回复

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":"我来拜访Cybozu, Inc.了。"
},
"id":"01234567-0123-0123-0123-0123456789ab",
"recordId":"2",
"type":"ADD_RECORD_COMMENT",
"url":"https://example.cybozu.com/k/1/show#record=2&comment=11"
}