Content of Webhook Notification Triggered by Actions in Kintone

When Webhook is enabled, Kintone sends notifications in the JSON format.
The following tables list the parameters of notifications for each action performed.

Adding Records/Editing Records/Updating Record Status

Parameter Value type Description
id Text Indicates a unique ID that is assigned for each notification.
type Text Indicates the type of action.
Record added: ADD_RECORD
Record edited: UPDATE_RECORD
Record status changed: UPDATE_STATUS
app Object The object that provides app information.
app.id Text Indicates an app ID.
app.name Text Indicates an app name.
record Object The object that provides record information.
The format is the same as the one for REST API that is used for retrieving records.
Retrieving Records (GET) (cybozu developer network)
recordTitle Text Indicates a record title.
The title field can be changed.
Setting the Record Title
url Text Indicates a record permalink.

Example of a Notification to Be Sent

{
"id":"01234567-0123-0123-0123-0123456789ab",
"type":"ADD_RECORD",
"app":{
"id":"1",
"name":"Lead Management"
},
"record":{
"Record number":{
"type":"RECORD_NUMBER",
"value":"2"
},
...(omitted)...
"$revision":{
"type":"__REVISION__",
"value":"3"
},
"$id":{
"type":"__ID__",
"value":"2"
}
},
"recordTitle":"Visit: Cybozu, Inc.",
"url":"https://example.kintone.com/k/1/show#record=2"
}

Deleting Records

Parameter Value type Description
id Text Indicates a unique ID that is assigned for each notification.
type Text Indicates the type of action.
Record deleted: DELETE_RECORD
app Object The object that provides app information.
app.id Text Indicates an app ID.
app.name Text Indicates an app name.
recordId Text Indicates a record number. It does not contain app codes.
deletedBy Object The object that provides information on a user who deleted the record.
deletedBy.code Text Indicates a user login name.
deletedBy.name Text Indicates a user name.
deletedAt Text Indicates deleted date and time

Example of a Notification to Be Sent

{
"app":{
"id":"1",
"name":"Lead Management"
},
"id":"01234567-0123-0123-0123-0123456789ab",
"recordId":"2",
"deletedBy":{
"code":"sato",
"name":"John Jones"
},
"deletedAt":"2017-07-03T09:38:09Z"
"type":"DELETE_RECORD"
}

Posting Comments

Parameter Value type Description
app Object The object that provides app information.
app.id Text Indicates an app ID.
app.name Text Indicates an app name.
comment Object The object that provides information on comments.
The format is the same as the one for REST API that is used for retrieving records.
Retrieving Record Comments in Bulk (cybozu developer network)
id Text Indicates a unique ID that is assigned for each notification.
recordId Text Indicates a record number. It does not contain app codes.
type Text Indicates the type of action.
Comment posted: ADD_RECORD_COMMENT
url Text Indicates a comment permalink.

Example of a Notification to Be Sent

{
"app":{
"id":"1",
"name":"Lead Management"
},
"comment":{
"createdAt":"2012-02-03T09:38:09Z",
"creator":{
"code":"kato",
"name":"Mary Smith"
},
"id":"11",
"mentions":[{
"code":"kato",
"type":"USER"
},{
"code":"org1",
"type":"ORGANIZATION"
},{
"code":"group1",
"type":"GROUP"
}],
"text":"I visited Cybozu, Inc. "
},
"id":"01234567-0123-0123-0123-0123456789ab",
"recordId":"2",
"type":"ADD_RECORD_COMMENT",
"url":"https://example.kintone.com/k/1/show#record=2&comment=11"
}