書類が、Webhookの追加時に設定した「通知する条件」の状態になると、指定された URL に対して以下のIPアドレスからPOST を行います。
本番環境の場合
52.68.17.229/32 または 52.198.144.82/32 または 3.112.114.42
sandbox環境の場合
52.197.119.179/32
その際、値はそれぞれ以下のようになります。
Content-Type: application/json
User-Agent: CloudSignWebHook
Body: {JSON}
Body の JSON の内容は以下のようになります。なお、見やすくするように改行を入れていますが、実際には1行で、プロパティ名と値の間には空白は入りません。
{
"documentID": "{documentID}",
"status": 2,
"userID": "{userID}",
"email": "user@example.com",
"text": "COMPLETED : 業務委託契約 sent by Jane Doe\n<https://www.cloudisign.jp/document/{documentID}/summary>"
}
JSONの各プロパティの詳細
documentID:
documentIDは書類を一意に識別する ID です。書類の詳細を取得するには、書類取得 API GET /documents/{documentID} をご利用ください。
status:
statusは書類の状態を示します。詳細はクラウドサイン Web API ドキュメント 内の documentModel をご確認ください。1: 先方確認中
2: 締結完了
3: 取り消し・却下
userID:
UserIDは、クラウドサイン内でユーザーを一意に識別するための ID です。ここでは書類の送信者の ID が記されます。
email:
emailには、書類の送信者のメールアドレスが記されます。
text:
textには、書類に関する以下のような情報が記されます。COMPLETED: 書類の締結完了時
CANCELED: 書類の取り消し・却下時
BOUNCED: 確認依頼メール、転送メール、締結完了メールの不達時
※どのメールが不達になったかは、上記
statusプロパティの値をご確認いただき判断ください。statusが「1」：確認依頼メール or 転送メールstatusが「2」：締結完了メール
書類のタイトル
送信者の名前
クラウドサイン上の書類確認用 URL