契約の状況(署名依頼・署名完了など)が変わったとき、外部のシステムへ自動で通知を送る「Webhook(ウェブフック)」機能の設定方法や検証方法について解説しています。複数の通知先を登録し、通知先ごとに受け取りたいイベントを選べます。
API連携やAPIユーザーキー(APIシークレットキー)の発行方法などは下記のヘルプセンター記事をご参照ください。
▷API連携・APIユーザーキー(APIシークレットキー)の設定・発行方法(ヘルプセンター)
※社内システムと連携・開発が伴う場合、技術提供費用として別途料金が発生します。詳しくは下記フォームよりお問い合わせください。
▷オプションに関するお問い合わせフォーム(GMOサインサービスサイト)
利用可能プラン:スタンダードビジネスエンタープライズ契約印&実印プラン
操作可能ロール: 全体管理者システム管理者
機能詳細
Webhookとは
GMOサインで契約のイベント(署名依頼・署名完了など)が起きたときに、あらかじめ登録した外部システムのURLへ、GMOサインから自動で連絡を送る仕組みです。連絡を受け取る側のURLを「通知先URL」と呼びます。このイベントを起点として連携先サービスに対して自動で締結文書を紐づけたりGMOサイン上の文書詳細情報の登録などができます。
1. GMOサインで契約のイベントが発生します(例:署名が完了した)。
2. GMOサインが、登録済みの通知先URLへデータ(JSON形式)を自動で送信します。
3. 受け取った外部システムが、あらかじめ決めた処理(チャットへの通知、契約書PDFの取り込みなど)を実行します。
<注意点>
- 通知先URLの「URLの検証」が完了するまで、通知は送信不可
- GMOサインのシステムが不正利用と検知したURLは登録不可(インターネットから到達できる公開URLを指定してください。)
- リダイレクト(転送)先への通知不可
※2026/10/21のリリース前から設定済みの Webhook は引き続き利用可能です(締結完了時に通知します。既存の仕様から変更はありません)。
通知について
| 通知の対象 | Ver.1/Ver.2 のWeb画面およびAPI経由のイベント |
|---|---|
| 通知タイミング |
|
| 通知先登録上限 | 20個まで |
| 通知失敗時のリトライ処理 |
|
通知されるイベントの種類
| イベント | 通知されるタイミング | 補足 |
|---|---|---|
| 署名依頼 | 署名者へ署名依頼のメールが送信されるとき | 署名順が複数ある契約では、署名順が始まるたびに通知されます。承認者が設定されている契約では、承認がすべて完了してから最初の通知が送られます。 |
| 署名完了 | すべての署名者の署名が終わり、最後の文書処理まで完了したとき | 最後の方が署名した直後ではなく、処理が完了した時点です。1つの契約につき1回だけ通知されます。 |
| 承認依頼 | 承認者へ承認依頼のメールが送信されるとき | 承認者が設定されている契約のみ対象です。承認順ごとに通知されます。 |
| 却下 | 承認者が社内の承認フローの途中で「却下」したとき | 署名者の「辞退」とは異なるイベントです。 |
| 取消 | 依頼した側が、送信後に署名依頼を取り消し(取り下げ)たとき | − |
| 署名者辞退 | 署名者が署名を辞退(拒否)したとき | 承認者の「却下」とは異なるイベントです。 |
Webhookの登録手順
事前に、通知を受け取る側のURLをご用意ください。連携サービス(Yoom、Zapierなど)を使う場合は、そのサービスで表示されるWebhook用のURLをコピーしておいてください。
1. 「管理者メニュー」をクリックします。
2. 「Webhook連携」より[新規登録]ボタンをクリックします。
3. 「必須」項目を入力し[登録する]ボタンをクリックして保存します。保存すると、Webhook IDが自動で発行されます。
| 項目名 | 入力 | 詳細 |
|---|---|---|
| Webhook名 | 必須 | 管理用の名前です。自由に付けられます(例:○○連携用、基幹システム通知用)。 |
| Webhook ID | 自動発行 | 保存すると自動で付く、通知先ごとに異なる識別番号です。APIで契約を作成するときの通知先の指定や、受け取ったデータでどの通知先からの通知かを確認するときに使います。入力は不要です。 |
| URL | 必須 | 通知を受け取る外部システムのURLです(https://から始まるURL)。クエリパラメータ付きURLも設定可 |
| 利用種別 | 必須 |
どの方法で作成された契約を通知の対象にするかを選びます(1つ選択)。
使い分け方法は下記「利用種別について(使い分けの目安)」をご参照ください。 |
| 通知する条件(通知イベント) | 必須 | 通知してほしいイベントをチェックします(複数選択可)。詳細は「通知されるイベントの種類」をご参照ください。 |
利用種別について(使い分けの目安)
| 選択肢 | 使い分け例 |
|---|---|
| API | 基幹システムや SFA/CRM などと連携して契約を自動作成している。その連携契約にだけルールを適用したい(画面から作る契約には影響させたくない。) |
| Web | 担当者が画面から手動で作る契約だけを対象にしたい(API 連携の契約には適用させたくない。) |
| APIとWebの両方 | 作成経路に関係なく、全契約へ一律に適用したい。 |
4. 登録完了後は自動的に「URLの検証」画面に遷移します。続けて「URLの検証」を行ってください。
※一部SaaSサービスのURLを設定する場合は、「URLの検証」は不要となる場合があります。そのまま「署名依頼の送信」等のイベントが発生した際、イベントに応じた連携が行われるかご確認ください。
Webhook一覧画面に登録内容が表示されていれば設定は完了です。
URLの検証手順
GMOサインが用意する確認用のHTMLファイルを通知先のサーバーに置き、GMOサインがそのファイルにアクセスして中身が正しければ、検証完了です。※確認用ファイルの内容は通知先ごとに異なるため、ほかの通知先に使い回すことはできません。
SlackやkintoneなどのSaaS連携では、サーバーに確認用ファイルを配置できないことがありますので、下記フォームよりお問い合わせください。
▷お問い合わせフォーム
検証画面の開き方
- 登録した直後:保存すると自動で検証画面が開きます。
- 後から行う場合:[Webhook設定]の一覧で、対象の通知先にある[URLを検証する]ボタンをクリックします。
検証手順
1. 検証画面の[htmlをダウンロード]ボタンをクリックして、確認用ファイルをダウンロードします。
※ファイル名はgmosign_activation.htmlのまま変更しないでください。画面にコードが表示されている場合は、そのコードをコピーして、gmosign_activation.htmlというファイル名で保存しても問題ありません。
2. ダウンロードしたファイルを、通知先のサーバーに置きます(必要に応じてブラウザで置いたファイルのURLを開き、表示されるかご確認ください)。
確認用ファイルは、登録したURLと同じ階層(ディレクトリ)に置いてください。ほかの階層やドメイン直下に置いても認められません。
| 登録したURL | 確認用ファイルを置く場所 |
|---|---|
| https://my-page.com/webhook/ | https://my-page.com/webhook/gmosign_activation.html |
| https://my-page.com/webhook/notify | https://my-page.com/webhook/gmosign_activation.html |
| https://my-page.com/webhook/notify.php?key=abc | https://my-page.com/webhook/gmosign_activation.html(?以降は無視されます) |
| https://my-page.com | https://my-page.com/gmosign_activation.html |
3. 検証画面の右下にある[URLの検証を実施]ボタンをクリックします。
4. 検証が成功すると、一覧の[URLを検証する]ボタンが非表示になり、通知が有効になります。
検証がうまくいかないとき
接続できない・時間切れになる
下記起因の可能性があります。URLの綴りとサーバーの状態を確認し、インターネットから接続できるようにしてください。
- サーバーが停止している
- ファイアウォールで遮断されている
- URLが間違っている
ファイルが見つからない
ファイルの場所やファイル名が違う可能性があります。上記の表のとおりの場所に、gmosign_activation.htmlという名前で置かれているか確認してください。
内容が一致しない
別の通知先用のファイルを置いている、ファイルを編集してしまった、古いファイルが残っている可能性があります。この通知先の検証画面で、もう一度ファイルをダウンロードして、そのまま置き直してください。
転送(リダイレクト)される
GMOサインは転送先を追いかけません。転送されない場所に置くか、最終的なURLを登録し直してください。
Webhookの編集・削除手順
※登録済みのURLを変更すると、検証は未完了の状態に戻ります。新しいURLで、もう一度検証を行ってください。
1. Webhook一覧画面より、対象の「Webhook名」をクリックします。
2. 画面上部の[メニュー]ボタンをクリックすると表示される「Webhookの変更/Webhookの削除」より操作します。
※削除した通知先には、以降は通知が送信されません。
通知失敗時の再送(リトライ)
受信側のサーバーが一時的に止まっているなどして通知が届かなかった場合、GMOサインが自動で再送(リトライ)します。
Ver.1(Web/API)の場合
再送は最大2回、5分間隔(毎時 00分 / 05分 / 10分 / 15分...)で行われます。最後まで失敗した通知は、それ以上は送信されません。
| 受信側の応答 | GMOサインの動き |
|---|---|
| 2xx(200〜299) | 成功レスポンスのため、再送は行われません。 |
| 2xx(200〜299)以外 | 成功レスポンス以外の為、再送します。 |
Ver.2(Web/API)の場合
再送は最大2回、10分間隔(毎時 00分 / 10分 / 20分 / 30分...)で行われます。最後まで失敗した通知は、それ以上は送信されません。
| 受信側の応答 | GMOサインの動き |
|---|---|
| 2xx(200〜299) | 成功レスポンスのため、再送は行われません。 |
| 5xx(サーバーエラー)、時間切れ、接続できない | 一時的な問題の可能性があるため、自動で再送します。 |
| 4xx(URLが異なる、認証エラーなど) | 再送しても解決しない可能性が高いため、再送しません。 |
| 3xx(リダイレクト) | 転送先へは送信せず、失敗扱いとなります。 |
Webhook通知とAPIリクエスト時の注意点
Ver.1の場合
Webhookは、Ver.1のAPIリクエストでis_web_hookに1(あり)を指定した依頼が対象です。
通知の本文には、封筒トランザクションID(xid。旧版の署名位置設定APIで依頼した文書は文書トランザクションID)とstatusのみが含まれます。署名済みPDFや契約の詳細が必要な場合は、受け取ったxidを使って、外部システムからGMOサインのAPIを呼び出します。
Ver.2の場合(登録先登録画面で自動発行された、「Webhook ID」を指定した依頼が対象)
署名済みPDFのダウンロードや契約の詳細が必要な場合は、受け取ったtransaction_idを使って、外部システムからGMOサインのAPIを呼び出します。
APIはユーザーごとのAPIキーを利用します。そのユーザー自身が関わっていない契約(送信者・承認者・署名者・閲覧者のいずれでもない契約)の情報は取得できず、エラーになります。
そのため、Webhookと連携する場合は次のように設定する運用となります。
1. GMOサインに外部連携専用のユーザーを用意します。
2. そのユーザーに、組織内のすべての契約を参照できる特権の権限(個別権限)を付与します。
3. そのユーザーのAPIキーを、外部システムに設定します。
<注意点>
この権限を持つAPIキーは、組織内のすべての契約を参照できます。漏えいしないよう厳重に管理し、連携を解除する場合はキーを無効にしてください。
- 2026/10/21:複数のWebhook登録(最大20件)・イベント選択機能リリース予定