Content of Webhook Notifications Triggered by Actions on kintone

Article Number:040602

Activating Webhooks allows notifications to be sent from kintone in JSON format.
The tables below show the parameters that are used in the notifications triggered by each event.

Record is added / Record is edited / Status is changed

Parameter Data type Description
id String Indicates a unique ID that is assigned to each notification.
type String Indicates the type of event.
Record is added: ADD_RECORD
Record is edited: UPDATE_RECORD
Record status is changed: UPDATE_STATUS
app Object The object that presents app information.
app.id String Indicates the app ID.
app.name String Indicates the app name.
record Object The object that presents record information.
The format of the object is the same as that in the REST API for retrieving the details of a record.
获取记录(GET) (cybozu developer network)
recordTitle String Indicates the record title.
You can change which field is used as the record title.
Setting Title Field
url String Indicates the record permalink.

Notification example

{
    "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.cybozu.com/k/1/show#record=2"
}

Record is deleted

Parameter Data type Description
id String Indicates a unique ID that is assigned to each notification.
type String Indicates the type of event.
Record is deleted: DELETE_RECORD
app Object The object that presents app information.
app.id String Indicates the app ID.
app.name String Indicates the app name.
recordId String Indicates the record number. This does not include the app code.
deletedBy Object The object that presents information about the user who deleted the record.
deletedBy.code String Indicates the user login name.
deletedBy.name String Indicates the user name.
deletedAt String Indicates the date and time when the record is deleted.

Notification example

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

Comment is posted

Parameter Data type Description
app Object The object that presents app information.
app.id String Indicates the app ID.
app.name String Indicates the app name.
comment Object The object that presents information about the comment.
The format of the object is the same as that in the REST API used for retrieving record comments.
批量获取记录的回复 (cybozu developer network)
id String Indicates a unique ID that is assigned to each notification.
recordId String Indicates the record number. This does not include the app code.
type String Indicates the type of event.
Comment is posted: ADD_RECORD_COMMENT
url String Indicates the comment permalink.

Notification example

{
    "app":{
        "id":"1",
        "name":"Lead Management"
        },
    "comment":{
        "createdAt":"2012-02-03T09:38:09Z",
        "creator":{
            "code":"kato",
            "name":"Misaki Kato"
            },
        "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.cybozu.com/k/1/show#record=2&comment=11"
}