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":"往訪：サイボウズ株式会社",
    "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":"サイボウズ株式会社に往訪してきました。"
        },
    "id":"01234567-0123-0123-0123-0123456789ab",
    "recordId":"2",
    "type":"ADD_RECORD_COMMENT",
    "url":"https://example.cybozu.com/k/1/show#record=2&comment=11"
}