Skip to main content
These events fire on the record create page. Use them to set default field values, validate inputs before saving, and respond after a new record is successfully created.
Register all event handlers using kintone.events.on(). See Event handling for usage details.

​
Onload event

Triggered after the record create page is displayed.
Event type: app.record.create.showTriggered timing: After the record create page is displayed.Event object properties:
PropertyTypeDescription
typeStringThe event type. Returns app.record.create.show.
appIdNumberThe app ID.
recordObjectThe record data (field values) on the create page.
reuseBooleantrue if the record was opened by clicking Reuse on a previously saved record; otherwise false.
Available actions: Return a Promise to wait for asynchronous operations before the page renders.
kintone.events.on('app.record.create.show', function(event) {
  var record = event.record;

  // Pre-fill a default value
  record.AssignedTo.value = [{ code: kintone.getLoginUser().code }];
  return event;
});

​
Save event

Triggered when the Save button is clicked on the record create page, before the data is sent to the server.
Event type: app.record.create.submitEvent object properties:
PropertyTypeDescription
typeStringThe event type. Returns app.record.create.submit.
appIdNumberThe app ID.
recordObjectThe record data entered by the user.
Canceling the save:You can cancel the save by doing one of the following:
  • Set a field error on event.record[fieldCode].error
  • Set a record error on event.error
  • Return false
Available actions:
  • Overwrite field values
  • Show field errors
  • Show record errors
  • Return a Promise to delay saving until asynchronous operations finish
kintone.events.on('app.record.create.submit', function(event) {
  var record = event.record;

  if (!record.ProjectCode.value) {
    record.ProjectCode.error = 'A project code is required.';
    return event;
  }

  return event;
});

​
Save success event

Triggered after a new record is successfully saved from the record create page.
This event does not trigger if the record fails to save.
Event type: app.record.create.submit.successEvent object properties:
PropertyTypeDescription
typeStringThe event type. Returns app.record.create.submit.success.
appIdNumberThe app ID.
recordIdNumberThe record ID of the newly created record.
recordObjectThe record data of the saved record.
Available actions: Set event.url to redirect the user to a specific URL after saving.
kintone.events.on('app.record.create.submit.success', function(event) {
  // Redirect to the record detail page after creation
  event.url = '/k/' + event.appId + '/show#record=' + event.recordId;
  return event;
});

​
Field change event

Triggered when the value of a specified field changes on the record create page. Replace (fieldcode) with the actual field code of the target field. Supported field types:
  • Single-line text (triggers when the field loses focus or a lookup copies a value)
  • Number (triggers when the field loses focus or a lookup copies a value)
  • Radio button
  • Check box
  • Multi-choice
  • Drop-down
  • Date
  • Time
  • Date and time
  • User selection
  • Department selection
  • Group selection
  • Rich text
  • Subtable (for changes within subtable rows)
Event type: app.record.create.change.(fieldcode)Event object properties:
PropertyTypeDescription
typeStringThe event type. Returns app.record.create.change.(fieldcode).
appIdNumberThe app ID.
recordObjectThe record data at the time the field changed.
changesObjectData about the changed field and row.
changes.fieldObjectThe changed field object.
changes.rowObject or nullThe subtable row that contains the changed field, or null if outside a subtable.
Available actions:
  • Overwrite field values
  • Enable or disable field editing
  • Show field errors
  • Show record errors
  • Return a Promise to wait for asynchronous operations
kintone.events.on('app.record.create.change.Category', function(event) {
  var record = event.record;

  // Auto-set priority based on category
  if (record.Category.value === 'Urgent') {
    record.Priority.value = 'High';
  }

  return event;
});

Build docs developers (and LLMs) love

Get started for freeTalk to us