kintone 連携
サイボウズ kintone と Pigeon Workflow を連携すると、アプリのレコードを取り込んだり、処理結果を kintone に書き込めます。レコードの追加・編集をきっかけにワークフローを自動起動することもできます。
組織共有の連携です
この連携は組織単位で登録します。一度登録すれば、同じ組織のメンバーがワークフローから利用できます。 権限管理が有効な組織では、シークレットに「利用」権限を持つメンバーが利用できます。詳しくは権限管理の完全ガイドを参照してください。
1 つの連携 = 1 つのアプリ
kintone の連携はアプリ 1 つごとに登録します。複数のアプリを扱う場合は、アプリごとに連携を追加してください。
連携でできること
- kintone アプリのレコードを一覧または 1 件ずつ取り込む
- 絞り込み条件(クエリ)を指定して取り込む
- レコードの作成・更新・追加更新(重複チェックして無ければ作成)
- レコードの追加・編集・ステータス更新をきっかけにワークフローを自動起動
用意するもの(APIトークン)
連携したい kintone アプリで APIトークンを 1 つ発行します。あわせて次の 3 つの情報が必要です。
| 入力する項目 | 例 | 説明 |
|---|---|---|
| 表示名 | 営業管理アプリ | 連携を見分けるための名前です。 |
| ホスト名 | your-company.cybozu.com | kintone の URL に出てくるドメインです。 |
| アプリID | 42 | アプリの URL に含まれる番号です。 |
| APIトークン | — | 下記の手順でアプリ設定から発行します。 |
APIトークンを発行するときは、必要なアクセス権にチェックを入れてください。
| アクセス権 | これが無いとできないこと |
|---|---|
| レコード閲覧 | レコードの取得 |
| レコード追加 | レコードの作成 |
| レコード編集 | レコードの更新・追加更新 |
セットアップ手順
kintone で APIトークンを発行する
対象アプリの設定画面を開き、「APIトークン」→「生成する」をクリックします。 必要なアクセス権(上記)を選んで「保存」→「アプリを更新」をクリックします。 アプリを更新しないと設定が反映されません。
Pigeon Workflow に登録する
「設定」→「サービス連携」→「kintone」を開き、「連携を追加」をクリックします。表示名・ホスト名・アプリID・APIトークンを入力して保存します。
登録結果を確認する
「kintone連携を追加しました」と表示されれば完了です。 「連携を保存しましたが、接続テストに失敗しました」と出た場合は、APIトークンのアクセス権とアプリの更新漏れを確認してください。 一覧の接続テストボタンでいつでも確認できます。
レコードの変更で自動起動する
kintone でレコードが追加・編集されたときにワークフローを自動で動かせます。 連携を追加すると Webhook URL が表示されるので、それを kintone 側に登録します。
Webhook URL は追加時に一度だけ表示されます
閉じると再表示できません。紛失した場合は、連携一覧の再生成ボタンで新しい URL を発行し、kintone 側に登録し直してください。
Webhook URL をコピーする
連携を追加したときに表示される Webhook URL をコピーします。
kintone に登録する
kintone アプリの設定 →「Webhook」→「+」をクリックし、コピーした URL を貼り付けます。 通知するイベント(レコードの追加・編集・ステータスの更新)を選んで「保存」→「アプリを更新」をクリックします。
ワークフローにトリガーを置く
ワークフローに kintone トリガーノードを置き、連携と受け取りたいイベント(レコード追加 / レコード編集 / ステータス更新)を選びます。
ワークフローで使えるノード
| ノード | できること | 主な設定 |
|---|---|---|
| kintone 取得 | アプリからレコードを取得します(一覧・1 件取得) | kintone 連携 / 操作 / レコードID / クエリ / 最大取得件数 / 取得フィールド |
| kintone 保存 | レコードを作成・更新・追加更新します | kintone 連携 / 操作 / レコードID / 重複キーフィールド / フィールドマッピング |
| kintone トリガー | レコードの追加・編集・ステータス更新でワークフローを起動します | kintone 連携 / トリガーイベント |
注意点と制限
短時間に大量のレコードを更新すると、通知が届かないことがあります
kintone 側の仕様で、1 分間に 60 件を超える通知は送信されません(同じドメインの全アプリ合計)。 超えた分はエラーにもならず届かないため、Pigeon Workflow 側で取りこぼしを補うことができません。 一括インポートなど大量更新を行う場合は、トリガーではなく定期実行でまとめて取り込む形をおすすめします。
- 「アプリを更新」を忘れると設定が反映されません。APIトークン・Webhook のどちらも、保存後にアプリの更新が必要です。
- レコードの作成は自動で再試行しません。同じレコードが二重に作られるのを防ぐためです。通信が不安定なときは実行が失敗として記録されるので、内容を確認してから再実行してください。
- 同じドメインへの同時アクセス数には kintone 側の上限があります。複数のワークフローが同じ kintone を同時に扱うと待たされることがあります。
- 連携を削除すると、その連携を使っているワークフローの kintone ノードは動かなくなります。