透過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 字串 記錄的連結。

傳送的通知範例

{
"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股份有限公司",
"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相同。
大量取得記錄回覆（cybozu developer network）
id 字串 分配給每筆通知的固定ID。
recordId 字串 記錄號碼。不包含應用程式代碼。
type 字串 操作的種類。
已填寫回覆：ADD_RECORD_COMMENT
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股份有限公司。"
},
"id":"01234567-0123-0123-0123-0123456789ab",
"recordId":"2",
"type":"ADD_RECORD_COMMENT",
"url":"https://example.cybozu.com/k/1/show#record=2&comment=11"
}