Webhook 機能

クラウドサインでは以下のタイミングにメールでお知らせをしております。

書類の締結完了時
書類の取り消し・却下時
以下のメール不達時
- 確認依頼メール
- 書類転送メール
- 締結完了メール

スタンダードプラン、コーポレートプラン、ビジネスプランをご利用の場合には、チームのメンバーが送信した書類が上記のいずれかの状態になったタイミングに指定された URL にアクセスする Webhook という機能がご利用いただけます。

Webhookの通知先設定数は最大20個まで設定可能です。

設定方法
実行時の挙動

設定方法

設定時

クラウドサインにログインし、チームにアクセスして下さい。
下部にある「Webhookを追加」ボタンをクリックして下さい。
「Webhookを追加」をクリックすると、各種情報を入力できます。以下の情報を入力し、「保存」をクリックして下さい。
・URL：アクセスしてほしい URLを入力して下さい。
・説明：このWebhookの説明を任意で入力して下さい。（例：情報システム部門へ通知する）
・通知する条件：通知したいタイミングを選択して下さい。（複数選択可）
以上でWebhookの設定は完了です。

設定変更時

設定を変更したいWebhookの「設定を変更」をクリックして下さい。
「設定を変更」をクリックすると追加した各種情報が表示されます。
必要な情報を変更し、「保存」をクリックして下さい。
以上で設定の変更は完了です。

削除時

削除したいWebhookのゴミ箱マークをクリックします。
「下記のWebhookを削除しますか？」で「削除」を選択します。
※削除するWebhookに説明が登録されていない場合には、[未設定]と表示されます。
以上で、削除は完了です。

実行時の挙動

書類が、Webhookの追加時に設定した「通知する条件」の状態になると、指定された 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
確認依頼メール・転送メール・締結完了メールの不達時: BOUNCED
書類のタイトル
送信者の名前
クラウドサイン上の書類確認用 URL

検索ワード

webhook