Last updated on
2025年11月5日
設定オプション
Webhook を設定するには、次の 5 つの要素を定義する必要があります。
- 名前 - 他の管理者が簡単に理解できる直観的な名前が推奨されます。
- スコープ：webhook がキャッチするネットの範囲。 アカウントとグループはインターフェイスで使用できます。
- API は、アカウント、グループ、ユーザー、リソースのスコープをサポートします。
- Webhook ごとに 1 つのスコープのみを定義できます。
- URL：Acrobat Sign が JSON ペイロードをプッシュしたターゲット URL。
- イベント：Acrobat Sign による JSON の構築と URL へのプッシュを引き起こすトリガー。
- 各イベントは、トリガーイベントに関連する異なるペイロードを構築します。
- 1 つの webhook に複数のイベントを含めることができます。
- 通知パラメーター：通知パラメーターは、イベントの JSON ペイロードのセクションを特定するので、この webhook にとって重要なイベントのセクションのみを選択できます（これにより、URL に送信される不要なデータが削減されます）。
Webhook を完全に定義して、「保存」をクリックすると、新しい webhook がトリガーイベントに即座に反応し始めます。
メモ
上記で説明した検証プロトコルに従って webhook 検証と webhook 通知のリクエストに応答するように、webhook URL を設定してください。 Acrobat Sign web アプリケーションから作成された webhook に送信されるクライアント ID（アプリケーション ID）は、「UB7E5BXCXY」です。
スコープ
- アカウント：アカウント内で発生するすべての購入済みイベントにより、プッシュがトリガーされます。
- アカウント管理者には、アカウントとそのアカウント内のすべてのグループに定義されているすべての webhook を表示する権限があります。
- グループ：グループ内で発生するすべての購入済みイベントにより、プッシュがトリガーされます。 注意：グループをスコープとする webhook は、その 1 つのグループにのみ存在します。
- グループ管理者には、自分のグループ専用の webhook のみが表示されます。 アカウントレベルの webhook や他のグループにバインドされている webhook は表示されません。
- 「ユーザーの複数グループ所属」が有効になっているアカウントでは、スコープを適用するグループを設定するオプションが表示されます。
- ユーザーアカウント：ユーザーアカウントのすべての購入済みイベントによりプッシュがトリガーされます。 ユーザーレベルの webhook は、API からのみ作成できます。
- リソースレベルの webhook：これは、特定のリソース用に作成されます。 このリソースに固有のイベントが、webhook URL にプッシュされます。 リソースレベルの webhook は、API からのみ作成できます。
URL
Webhook URL は、イベントの発生時にトリガーされる受信 HTTPS POST 通知メッセージをリッスンするサーバーです。
イベントへの webhook をサブスクライブするには、この URL が必要です。
- クライアントには、Acrobat Sign が POST できる HTTPS URL を含める必要があります。 この URL は、パブリックインターネット上で利用できる必要があります。
- 例えば、127.0.0.1 やローカルホスト URL は機能しません。
- URL エンドポイントは、ポート 443 または 8443（コールバック URL の定義時にお客様が決定）でリッスンする必要があります。
- Webhook が受信イベント通知の POST リクエストと検証リクエストの GET リクエストをサポートしていることを確認してください。
- URL はファイアウォールでブロックしないでください。
イベント
以下は、webhook URL へのプッシュをトリガーできるイベントです。オブジェクト別にグループ化され、UI に表示される順序で示されています。
左側の値は、Acrobat Sign UI に表示される値です。 右側の値は、API での webhook 名です。
Webhook とそのペイロードについて詳しくは、Acrobat Sign デベロッパーガイドを参照してください。
契約書：
| UI 要素 | Webhook 名 |
| 契約書のすべてのイベント | AGREEMENT_ALL |
| 契約書が作成されました | AGREEMENT_CREATED |
| 契約書が送信されました | AGREEMENT_ACTION_REQUESTED |
| 契約書の参加者が完了しました | AGREEMENT_ACTION_COMPLETED |
| 契約書ワークフローが完了しました | AGREEMENT_WORKFLOW_COMPLETED |
| 契約書の期限が切れています | AGREEMENT_EXPIRED |
| 契約書が削除されました | AGREEMENT_DOCUMENTS_DELETED |
| 契約書はキャンセルされました | AGREEMENT_RECALLED |
| 契約書が辞退されました | AGREEMENT_REJECTED |
| 契約書が共有されました | AGREEMENT_SHARED |
| 契約書が共有解除されました | AGREEMENT_UNSHARE |
| 契約書が共有解除されました (自動) | AGREEMENT_UNSHARE_AUTO |
| 契約書が委任されました | AGREEMENT_ACTION_DELEGATED |
| 契約書の参加者が置き換えられました | AGREEMENT_ACTION_REPLACED_SIGNER |
| 契約書が変更されました | AGREEMENT_MODIFIED |
| 契約書の変更が確認されました | AGREEMENT_USER_ACK_AGREEMENT_MODIFIED |
| 契約書の電子メールが閲覧されました | AGREEMENT_EMAIL_VIEWED |
| 契約書の電子メールが戻ってきました | AGREEMENT_EMAIL_BOUNCED |
| 契約書の WhatsApp 送信が戻ってきました | AGREEMENT_WHATSAPP_BOUNCED |
| 契約書の SMS 送信が戻ってきました | AGREEMENT_SMS_BOUNCED |
| 契約書文書が閲覧されました | AGREEMENT_DOCUMENTS_VIEWED |
| 文書の表示にパスワードが適用されているときに契約書文書が閲覧されました | AGREEMENT_DOCUMENTS_VIEWED_PASSWORD_PROTECTED |
| 契約書の作成に失敗しました | AGREEMENT_AUTO_CANCELLED_CONVERSION_PROBLEM |
| オフラインイベント後に契約書が同期されました | AGREEMENT_OFFLINE_SYNC |
| 契約書が保管されました | AGREEMENT_VAULTED |
| 契約書の参加者のソーシャル ID が認証されました | AGREEMENT_WEB_IDENTITY_AUTHENTICATED |
| 契約書の参加者の KBA が認証されました | AGREEMENT_KBA_AUTHENTICATED |
| 契約書の参加者の電子メール OTP が認証されました |
AGREEMENT_EMAIL_OTP_AUTHENTICATED |
| 契約書の有効期限が更新されました | AGREEMENT_EXPIRATION_UPDATED |
| 契約書リマインダーが送信されました | AGREEMENT_REMINDER_SENT |
| 署名者が変更した契約書の署名者名 | AGREEMENT_SIGNER_NAME_CHANGED_BY_SIGNER |
| 契約書のリマインダーが開始されました | AGREEMENT_REMINDER_INITIATED |
| API 経由でのみ利用可能な契約書 webhook | |
| UI 要素 | Webhook 名 |
| NA |
AGREEMENT_READY_TO_NOTARIZE |
| NA |
AGREEMENT_READY_TO_VAULT |
一括送信：
| UI 要素 | Webhook 名 |
| 一括送信の全イベント | MEGASIGN_ALL |
| 一括送信を作成 |
MEGASIGN_CREATED |
| 一括送信を共有 |
MEGASIGN_SHARED |
| 一括送信をリコール |
MEGASIGN_RECALLED |
| 一括送信のリマインダーが送信されました | MEGASIGN_REMINDER_SENT |
| 一括送信のリマインダーが開始されました | MEGASIGN_REMINDER_INITIATED |
Web フォーム：
| UI 要素 | Webhook 名 |
| Web フォームのすべてのイベント | WIDGET_ALL |
| Web フォームが作成されました |
WIDGET_CREATED |
| Web フォームは有効になりました |
WIDGET_ENABLED |
| Web フォームは無効になりました |
WIDGET_DISABLED |
| Web フォームが変更されました |
WIDGET_MODIFIED |
| Web フォームが共有されました |
WIDGET_SHARED |
| Web フォームの作成に失敗しました |
WIDGET_AUTO_CANCELLED_CONVERSION_PROBLEM |
ライブラリテンプレート（API のみ）：
| UI 要素 | Webhook 名 |
| NA | LIBRARY_DOCUMENT_ALL |
| NA | LIBRARY_DOCUMENT_CREATED |
| NA | LIBRARY_DOCUMENT_AUTO_CANCELLED_CONVERSION_PROBLEM |
| NA | LIBRARY_DOCUMENT_MODIFIED |
通知パラメーター
通知パラメーターを使用すると、JSON ペイロードをイベントの特定の要素のみにカスタマイズできます。
例えば、契約書参加者の置換イベントで、契約情報および参加者情報のみが必要な場合、文書情報を除外することで、webhook URL に送信される JSON の合計サイズを小さくすることができます。
- 契約書
- 契約書情報：イベントトリガー時の契約書のステータスに基づく詳細な契約書情報。
- 契約文書情報：イベントの結果として生成された文書情報を含む。
- 契約書参加者情報：イベントの結果として参加者情報を含む。
- 契約署名済み文書：署名済み PDF を提供。
- 契約書ワークフローの完了およびすべての契約書イベントに適用。
- 一括送信
- 一括送信情報：イベントをトリガーした一括送信オブジェクトに関する詳細情報。
- Web フォーム
- ウィジェット情報 - イベントをトリガーした web フォームに関する詳細情報。
- ウィジェットの文書情報：web フォームに関連付けられている文書情報。
- ウィジェットの参加者情報：web フォームに定義された参加者に関する情報。
