Webhook 機能

クラウドサインでは書類の締結完了または却下・取消しの際に、メールでその旨をお知らせしております。
スタンダードプラン、コーポレートプラン、ビジネスプランをご利用の場合には、チームのメンバーが送信した書類の締結完了または却下・取消し時に指定された URL にアクセスする Webhook という機能がご利用いただけます。

設定方法
実行時の挙動

設定方法

クラウドサインにログインし、チームにアクセスして下さい。
下部にHook URL の入力欄がありますので、こちらにアクセスしてほしい URL を記して下さい。

実行時の挙動

書類が締結完了または却下・取消となると、指定された URL に対して以下のIPアドレスからPOST を行います。

本番環境の場合

52.68.17.229/32 または 52.198.144.82/32 または 3.112.114.42

sandbox環境の場合（2021/4/15 12:00以降）

52.197.119.179/32

その際、値はそれぞれ以下のようになります。

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",
  "text": "COMPLETED : 業務委託契約 sent by Jane Doe\n<https://www.cloudisign.jp/document/0591aeea-e2d4-417b-97f9-3b1a3751bc19/summary>"
}

documentID: documentID は書類を一意に示す ID です。書類の詳細を取得するには書類取得 API GET /documents/{documentID} をご利用ください。
status: status は書類の状態を示します。クラウドサイン Web API ドキュメント内の documentModel についての仕様で記していますが、締結完了の場合には 2 、却下・取り消しの場合には 3 となります。
userID: userID はユーザーを一意に示すクラウドサイン内で用いている ID で、ここでは書類の送信者の ID が記されます。
email: email は書類の送信者のメールアドレスを記します。
text: text には以下の内容を含むテキストが記されます。
締結された場合には COMPLETED 、却下・取り消しの場合には CANCELED から始まる状態
書類のタイトル
送信者の名前
クラウドサイン上の書類確認用 URL

検索ワード

webhook