上次更新時間
2025年11月5日
設定選項
設定 Webhook 需要定義五個元素：
- 名稱 - 讓其他管理員能夠快速瞭解其意思的直覺式名稱。
- 範圍 - Webhook 擷取的範圍有多大? 介面中有「帳戶」與「群組」。
- API 支援「帳戶」、「群組」、「使用者」與「資源」範圍。
- 只能為每個 Webhook 定義一個範圍。
- URL - Adobe Sign 將 JSON 裝載推往的目標 URL。
- 事件 - 造成 Adobe Sign 建置 JSON，並將其推送至該 URL 的觸發時機。
- 每個事件都會建置與觸發事件相關的不同裝載。
- 多個事件可包含在單一 Webhook 中。
- 通知參數 - 通知參數可識別事件 JSON 裝載的區段，允許您僅選取對此 Webhook 來說重要的事件區段 (以減少不必要的資料傳送至 URL)。
在完整定義 Webhook 後，按一下「儲存」，新的 Webhook 便會立刻開始對觸發事件做出反應。
備註
請設定 Webhook URL，以按照上文說明的驗證通訊協定來回應 Webhook 驗證與 Webhook 通知請求。 會發送至從 Acrobat Sign 網路應用程式建立的 Webhook 的用戶端 ID (應用程式 ID) 將為 - UB7E5BXCXY
範圍
- 帳戶：帳戶中發生的所有已訂閱事件都會觸發推送。
- 帳戶管理員有權查看所有為該帳戶和該帳戶中所有群組定義的 Webhook。
- 群組：該群組中發生的所有已訂閱事件都會觸發推送。 注意：群組範圍的 Webhook 僅為該群組存在。
- 群組管理員只能看到專屬於其群組的 Webhook。 他們無法看到帳戶層級的 Webhook，或綁定至其他群組的 Webhook。
- 啟用「使用者加入多個群組」的帳戶，將看到設定套用範圍的群組選項。
- 使用者帳戶：使用者帳戶的所有已訂閱事件都會觸發推送。 使用者層級的 Webhook 只能透過 API 建立。
- 資源層級 Webhook：將為特定資源建立此項。 特定於此資源的事件將推送至 Webhook URL。 資源層級的 Webhook 只能透過 API 建立。
URL
Webhook URL 是一種伺服器，會偵聽在事件發生時觸發的傳入 HTTPS POST 通知訊息。
您需要此 URL，讓 Webhook 訂閱事件。
- 用戶端必須包含 Acrobat Sign 可以 POST 到的 HTTPS URL。 此 URL 必須在網際網路上公開可用。
- 例如，127.0.0.1 和 localhost URI 都無法運作。
- 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 |
| 合約參與者的社會身分已驗證 | 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 |
| 合約 Webhook 僅透過 API 提供 | |
| 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 |
網頁表單：
| UI 元素 | Webhook 名稱 |
| 網頁表單所有事件 | WIDGET_ALL |
| 已建立網頁表單 |
WIDGET_CREATED |
| 已啟用網頁表單 |
WIDGET_ENABLED |
| 已停用網頁表單 |
WIDGET_DISABLED |
| 已修改網頁表單 |
WIDGET_MODIFIED |
| 已共用網頁表單 |
WIDGET_SHARED |
| 網頁表單建立失敗 |
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。
- 適用於已完成合約工作流程事件和所有事件的合約。
- 大量傳送
- 大量傳送資訊 - 有關觸發事件的「大量傳送」物件的詳細資訊。
- 網頁表單
- Widget 資訊 - 有關觸發事件的網頁表單的詳細資訊。
- Widget 文件資訊 - 與網頁表單有關的文件資訊。
- Widget 參與者資訊 - 有關網頁表單中已定義的參與者的資訊。
