Sign Webhook

Sign Webhook

Sign Webhookを使用すると、署名リクエストに伴って発生したイベントに関する通知を受信することができます。Sign Webhookを使用して、自分のアプリケーションで操作をトリガーしたり、Signで発生したイベントについてユーザーに通知したりできます。

署名リクエストが非同期処理で、署名者はいつでも (場合によってはアプリケーション外部でも) 署名リクエストを操作できるので、これは特に重要になります。

Sign関連のイベント

WebhookをトリガーできるSign関連のイベントがあります。Boxイベントの大半と同様、リスナーはフォルダレベルまたはドキュメントレベルで設定されます。

最も一般的なユースケースでは、署名リクエストが作成されるフォルダでイベントをリッスンします。このように、そのフォルダに作成されるすべての署名リクエストをリッスンできます。

リッスンできるイベントの例を以下に示します。

  • SIGN_REQUEST.COMPLETED: 署名リクエストが完了した。
  • SIGN_REQUEST.DECLINED: 署名リクエストが拒否された。
  • SIGN_REQUEST.EXPIRED: 署名リクエストの有効期限が切れた。
  • SIGN_REQUEST.SIGNER_EMAIL_BOUNCED: 署名者のメールが差し戻された。