Skip to main content

Authenticate to Kintone

After you add the connector, you need to set the required properties. URL: Enter the URL for your Kintone account. supports authenticating to Kintone in several ways. Select your authentication method below to proceed to the relevant section that contains the authentication details.

Password

API Token

To connect with an API token, specify these settings:
  • Auth Scheme: Select APIToken.
  • App Idz: Enter your application Id, which is the number of that specific application in the sequence under Apps in Kintone UI dashboard.
  • API Token: Enter your API token. To obtain the token:
    1. Access the specific application that you want and click the Settings icon.
    2. On the App Settings tab, click API Token.
    3. Click Generate to produce the API token.

OAuth

Complete Your Connection

To complete your connection:
  1. For Schema, select one of the following schema options:
    • (Default) REST: Select this option to connect to the Kintone REST API. The Kintone REST API supports all three authentication schemes (Password, API Token, and OAuth).
    • USER: Select this option to connect to the Kintone USER API. The Kintone USER API supports only the Password authentication scheme.
  2. Define advanced connection settings on the Advanced tab. (In most cases, though, you should not need these settings.)
  3. If you authenticate with OAuth, click Connect to Kintone to connect to your Kintone account.
  4. Click Create & Test to create your connection.

Transferring Data to the Kintone Destination

For reverse ETL, you can transfer data into Kintone using any of the following modes:
  • Insert: This mode enables you to insert new records into the target table. The only prerequisite is that the source table must have a primary key (PK).
  • Update: This mode updates the details of multiple records in a Kintone application. Records can be identified by using either their record identifier (Id) or unique keys (fields with the Prohibit duplicate values setting enabled). For instructions about enabling unique keys, see Prevent users from entering duplicate values with Prohibit Duplicate Values Fields’ Settings.
  • Upsert: This mode updates existing records and inserts new records when they do not exist already. You should use unique keys to determine whether a record should be updated or inserted.

Limitations for Using Kintone as a Reverse ETL Destination

Although the Kintone destination is supported for reverse ETL, certain limitations apply.

Unsupported Tables

supports data transfer only for tables that store user-entered records. Tables that are related to application configurations, permissions, automation, and notifications are not supported. The following tables are not supported:
  • Permissions tables: FieldPermissionsEntities, RecordPermissionsEntities, ActionSettingsEntities
  • Automation tables: ActionSettingsMappings, ProcessManagementActions, ReminderNotificationsTargets
  • Notifications tables: PerRecordNotificationsTargets, ReminderNotificationsTargets

Handling Table Data in Requests

If table data is not included in the request, the existing data within the table remains unchanged. If table data is included:
  • Any fields within the table that are not included in the request are deleted.
  • To retain specific fields, ensure that their values are included explicitly in the request.