💡API連携リリース以前（2026年5月以前）からREST API/Webhookをご利用のお客様へ
これまで試験的に提供しておりましたAPI連携機能を、正式リリースいたしました。
2026年5月以前からご利用いただいている「REST API/Webhook」および「APIドキュメント」については、
2026年内をめどに廃止を予定しております。
お手数ですが、API設定画面から新たにAPIキーまたはWebhookの設定・移行をお願いいたします。
なお、以前よりご利用いただいているAPIキー・Webhookの設定は、API設定画面には表示されない仕様です。
移行にあたり、以前から利用いただいているAPIの変更や廃止が必要な場合は、サポートまでお問い合わせください。

API連携について

YOMELから設定を行うことで、REST APIまたはWebhookによる外部サービスとのデータ連携が可能になります。

YOMELでは、以下の種類のキーを発行・利用できます。

• ユーザー単位のAPIキー・Webhookキー（全ユーザー発行可能）
• スペースのAPIキー・Webhookキー（スペース管理者のみ発行可能）

APIの詳細な仕様については、以下のドキュメントをご参照ください。

https://share.apidog.com/bf4a2b97-5126-4907-b447-9d191343b68d/doc-928108

API連携のキーの発行・管理、およびWebhookの設定は、ご利用の権限に応じて以下の画面から行います。

• ユーザー単位のキーを管理する　対象：全ユーザー

  「環境設定 > API設定」タブから、自分が発行したキーの一覧確認、作成、編集が行えます。

  発行者本人が参加しているグループが自動で対象になり、スペースの設定でプライベートモードが有効な場合、プライベートモードで記録したデータも取得できます。

  ※「グループ設定 > メンバーに対する制限 > 他メンバーログの閲覧制限」がオンの場合、自身のログのみ取得可能です。

  

• スペースのキーを管理する　対象：管理者のみ

  「スペース設定 > API設定」タブから、「スペース」のキー管理に加え、各ユーザーが発行したキーやプライベートモードのキーの確認・管理を行うことができます。

  

※IP制限が設定されているスペースでは、許可されたIPアドレスからのみ利用できます

新しいキーを作成する

画面内の［新しいAPIキーを作成］から、APIキーおよびWebhook設定の追加を行います。

1. APIキーを発行する

キーの作成画面で、各項目を以下のように設定してください。

設定完了後、発行されたAPIキーが表示されます。

⚠️APIキーは発行直後の画面でしか確認できません。必ずその場でコピーして保存してください。
キーを紛失した場合、対象キーの右側メニューにある「キーコピー」機能（設定の複製）を使って、
新しいキーを再発行する必要があります。

API設定画面上では、設定した「キー名」と「キー末尾4桁」のみ確認できます。

2. Webhookキーを発行する

キーの作成画面で、各項目を以下のように設定してください。

管理者が参加していないグループを指定する場合の注意

⚠️この注意事項は、スペース単位のキーにのみ適用されます。
ユーザー単位のキーは、発行者本人が参加しているグループが自動設定されるため、承認は不要です。

APIキーまたはWebhookの追加を行った管理者が、グループマネージャーとして参加していないグループを指定した場合、該当グループのグループマネージャーによる承認手続きが必要となります。

対象グループの「グループ設定画面>APIキー」タブに、グループマネージャーへのAPI承認依頼リクエストが表示されます。

承認依頼の承認・却下は、該当グループのグループマネージャーのみが行えます。

キーを発行した管理者が、該当グループのグループマネージャーの場合は、グループ設定からの承認を行う必要はなく、自動で承認されます。

設定の編集

発行済みのAPIキーおよびWebhookは、各キーの右側にある「三点リーダー（…）」メニューから操作・編集が可能です。

• キー編集

  キー種別、キー名、対象グループなどの変更を行えます。

  ※有効期限の変更は行えません。有効期限を迎えるキーの更新は「キーコピー」メニューから行ってください。

• キーコピー

  作成済みのキー設定を複製し、新しいキーを発行します。有効期限を延長したい場合などにご利用ください。

  ※スペース単位のキーの場合、設定を行った管理者がグループマネージャーとして参加していないグループを新たに指定した場合、該当グループのグループマネージャーによる承認が必要となります。
  詳しくは「管理者が参加していないグループを指定する場合の注意」を参照ください。

  ※プライベートモードのキー等、一部キーコピーが利用できない項目もあります。

• 無効にする / 有効にする

  作成済みのキーの無効化/有効化を行えます。

• キー削除

  作成済みのキーの削除を行えます。一度削除したキーは復元できませんのでご注意ください。

ユーザーのAPIキー発行を制限する

「スペース設定 > API設定」タブで、スペース内の全ユーザーが発行したユーザー単位キーが一覧表示され、有効/無効の切り替えを行うことが可能です。

APIキーの内容の閲覧・コピー・変更はできません。

「スペース設定 > 権限設定 > ユーザーのAPIキー発行をさせない」にチェックを入れると、スペースのすべてのユーザーが、ユーザー単位のAPIキーとWebhookを新規発行できなくなり、発行済みキーによるAPI利用とWebhook送信も停止します。

制限中、ユーザーのキー一覧画面には、「ユーザー単位APIの利用がスペース設定で制限されているため、新規発行はできません。発行済みキーのON/OFFは変更できます。」という通知バナーが表示されます。

発行済みキー自体の有効/無効の状態は変更されません。

チェックを外すと、発行済みキーによるAPI利用とWebhook送信が再開します。

よくある質問

Q. 〇〇（外部サービス名）との連携は可能ですか？

A. 連携可否は、連携させたいサービス側の仕様により異なります。

YOMELのAPIでは「Webhook（Push型）」と「REST API形式（Pull型）」の2種類を提供しており、いずれかに対応しているサービスのみが連携可能な対象となります。

なお、個別サービスへの具体的な設定方法や連携実績などについてはお答えいたしかねますので、あらかじめご了承ください。

Q. 発行可能なAPIキー・Webhookの数に上限はありますか？

A. 発行数の上限はありません。必要な分だけ作成いただけます。

Q. APIキーを紛失してしまったが、再発行可能でしょうか？

A. 一度紛失したAPIキーを再度確認することはできません。

ただし、設定画面のメニューにある「キーコピー」機能を使って、現在の設定内容を引き継いだ「新しいキー」を複製・再発行することは可能です。

新しいキーが発行されたら、外部サービス側の設定を新しいキーへ差し替えてください。

Q. APIキーの有効期限を「なし（無期限）」にすることは可能ですか？

A. できません。

セキュリティ観点から、最長1年でのキーのローテーションを推奨しております。

Q. Webhookの場合、有効期限はありますか？

A. ありません。

Webhookは設定画面で無効化の操作をしない限りは、永続的に有効となります。

Q. Webhookイベントの「要約開始」「要約終了」は、カスタム要約にも適用されますか？

A. はい、適用されます。

標準要約と同様に、カスタム要約の生成が開始・完了したタイミングでも該当のWebhookイベントが送信されます。