Skip to main content
These events fire on the record detail (view) page. Use them to customize the detail view, prevent record deletion, or react to process management status changes.
Register all event handlers using kintone.events.on(). See Event handling for usage details.

​
Onload event

Triggered after the record detail page is displayed.
Event type: app.record.detail.showTriggered timing: After the record detail page is displayed.Event object properties:
PropertyTypeDescription
typeStringThe event type. Returns app.record.detail.show.
appIdNumberThe app ID.
recordIdNumberThe record ID.
recordObjectThe record data displayed on the page.
Available actions: Return a Promise to wait for asynchronous operations before the page continues rendering.
kintone.events.on('app.record.detail.show', function(event) {
  var record = event.record;
  console.log('Viewing record ID:', event.recordId);
  console.log('Status:', record.Status.value);
  return event;
});

​
Delete event

Triggered when the Delete button is clicked in the confirmation dialog on the record detail page, before the record is deleted from the server.
Event type: app.record.detail.delete.submitEvent object properties:
PropertyTypeDescription
typeStringThe event type. Returns app.record.detail.delete.submit.
appIdNumberThe app ID.
recordIdNumberThe record ID.
recordObjectThe record data of the record to be deleted.
Canceling the deletion:You can cancel the deletion by doing one of the following:
  • Set a record error on event.error
  • Return false
Available actions: Return a Promise to delay the deletion until asynchronous operations finish.
kintone.events.on('app.record.detail.delete.submit', function(event) {
  var record = event.record;

  if (record.Archived.value === 'Yes') {
    event.error = 'Archived records cannot be deleted.';
    return event;
  }

  return event;
});

​
Update status event

Triggered when an action button in the process management panel is clicked on the record detail page, before the status update is sent to the server.
Event type: app.record.detail.process.proceedEvent object properties:
PropertyTypeDescription
typeStringThe event type. Returns app.record.detail.process.proceed.
appIdNumberThe app ID.
recordIdNumberThe record ID.
recordObjectThe record data at the time the action was triggered.
actionObjectThe action that was clicked.
action.valueStringThe name of the action.
nextStatusObjectThe status the record will transition to.
nextStatus.valueStringThe name of the next status.
assigneeObjectThe selected assignee (if applicable).
assignee.valueArrayAn array of user objects for the selected assignee.
Canceling the status update:You can cancel the status update by doing one of the following:
  • Set a record error on event.error
  • Return false
Available actions: Return a Promise to wait for asynchronous operations before the status update proceeds.
kintone.events.on('app.record.detail.process.proceed', function(event) {
  var record = event.record;

  // Require a comment before proceeding to "Approved"
  if (event.nextStatus.value === 'Approved' && !record.ApprovalNote.value) {
    event.error = 'An approval note is required before approving.';
    return event;
  }

  return event;
});

Build docs developers (and LLMs) love

Get started for freeTalk to us