Webhook 機能

Webhook機能とは、チームのメンバーが送信した書類が特定の状態に変化したときに、指定されたURLに対してHTTP POSTリクエストを送信し、外部のシステムに対して書類の状態変化を通知する機能です。

Web APIと組み合わせ、お客様の自社システム等との連携にご利用いただけます。

また、クラウドサインと連携可能な他社製品の一部にも、Webhookを利用するものがあります。

本機能は、スタンダードプラン、コーポレートプラン、ビジネスプラン、エンタープライズプランでご利用いただけます。

Webhookによる通知対象は、チームのメンバーが送信した書類です。
通知が可能なタイミングは、以下のとおりです。

• 書類の締結完了時

• 書類の取り消し・却下時

• 以下のメール不達時

  • 確認依頼メール

  • 書類転送メール

  • 締結完了メール

     

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

以下にWebhookの設定方法を記載しておりますが、Webhook実行時のレスポンスなどの挙動の説明は「Webhook実行時の挙動」をご確認ください。

設定方法

設定時

1. クラウドサインにログインし、 「Web API設定」にアクセスしてください。

2. 下部にある「Webhookを追加」ボタンをクリックしてください。

   

3. 「Webhookを追加」をクリックすると、各種情報を入力できます。以下の情報を入力し、「保存」をクリックしてください。

   ・URL：Webhookを送信する宛先のURLを入力してください。

   ・説明：このWebhookの説明を任意で入力してください。（例：情報システム部門へ通知する）

   ・通知する条件：通知したいタイミングを選択してください。（複数選択可）

   

4. 以上でWebhookの設定は完了です。

    

テスト送信時

設定したWebhookのURLに対して、テスト送信を実施することができます。

1. テスト送信したいWebhookの「テスト送信」をクリックしてください。
   
2. 画面上部に送信結果とステータスが表示されます。
3. 以上でWebhookのテスト送信は完了です。受信側の結果を確認してください。

※テスト送信でPOSTされるリクエスト本文は以下のとおりです。内容を変えることはできません。

設定変更時

1. 設定を変更したいWebhookの「設定を変更」をクリックしてください。

   

2. 「設定を変更」をクリックすると追加した各種情報が表示されます。

   必要な情報を変更し、「保存」をクリックしてください。

   

3. 以上で設定の変更は完了です。

    

削除時

1. 削除したいWebhookのゴミ箱マークをクリックします。

   

2. 「下記のWebhookを削除しますか？」で「削除」を選択します。

   

   
   ​

   ※削除するWebhookに説明が登録されていない場合には、[未設定]と表示されます。

   

   
   
   

3. 以上で、削除は完了です。

    

検索ワード

webhook