CloudSignチームのヘルプと回答

Web Hook 機能について

クラウドサインでは契約の完了(同意、または却下・取り消し)の際に、メールでその旨をお知らせしております。
エンタープライズプランをご利用の場合には、契約の完了時に指定された URL にアクセスする Web Hook という機能がご利用いただけます。

以下に Web Hook の設定方法を記します。

Web Hook の設定

  1. クラウドサインにログインし、 高度な設定 にアクセスして下さい。
  2. Hook URL の入力欄がありますので、こちらにアクセスしてほしい URL を記して下さい。

Web Hook 実行時の挙動

契約が完了すると、指定された URL に対して 52.68.17.229/32  から POST を行います。
その際、値はそれぞれ以下のようになります。

  • Content-Type: application/json
  • User-Agent: CloudSignWebHook
  • Body:  {JSON}

Body の JSON の内容は以下のようになります。なお、見やすくするように改行を入れていますが、実際には1行で、プロパティ名と値の間には空白は入りません。


{
  "documentID": "0591aeea-e2d4-417b-97f9-3b1a3751bc19",
  "status": 2,
  "userID": "b05e96a3-0406-4b43-af4b-80d2a37e5b73",
  "email": "user@example.com"
}

  • documentID: documentID は書類を一意に示す ID です。書類の詳細を取得するには書類取得 API GET /documents/{documentID} をご利用ください。
  • status: status は書類の状態を示します。 クラウドサイン Web API ドキュメント 内の documentModel についての仕様で記していますが、完了の場合には 2 、却下・取り消しの場合には 3 となります。
  • userID: userID はユーザーを一意に示すクラウドサイン内で用いている ID で、ここでは書類の送信者の ID が記されます。
  • email: email は書類の送信者のメールアドレスを記します。
回答が見つかりましたか?