Webhook通知を受け取る(トリガー)
このピースでできることクラウドサイン の接続方法環境クライアントIDピースの設定項目1. Webhook URL(入力不要)2. 設定手順(表示のみ)取得できる情報クラウドサイン管理画面での設定手順テスト方法補足
このピースでできること
- クラウドサインから送信されるWebhookイベントを受信したときに、フローを起動します。
- 書類の署名完了や取消など、クラウドサイン側で設定した通知イベントをきっかけに自動処理できます。
クラウドサイン の接続方法
以下の2つを入力して接続します。
環境
接続先の環境を選択します。
- プロダクション — 本番環境(通常はこちらを選択)
- サンドボックス — テスト・検証用環境
クライアントID
クラウドサインの管理画面から発行したクライアントIDを入力します。
- クラウドサイン管理画面にログインします
- 「外部連携」 または 「API 連携」 メニューを開きます
- クライアントIDを発行し、コピーします
- 接続画面の 「クライアントID」 欄に貼り付けます
サンドボックス環境でテストする場合は、サンドボックス用のクライアントIDを別途取得してください。
ピースの設定項目
1. Webhook URL(入力不要)
- フローを有効化すると、このピースにWebhook URLが表示されます。
- 表示されたWebhook URLを、クラウドサイン管理画面のWebhook設定に貼り付けてください。
2. 設定手順(表示のみ)
- クラウドサイン管理画面でWebhookを登録するための手順が表示されます。
- 表示内容に沿って設定してください。
取得できる情報
クラウドサインから受信したWebhookリクエストの情報を取得できます。
| 実際のキー | 内容・条件 |
|---|---|
| 通知本文。通知条件とクラウドサインが送る内容によって項目・階層が変わります。本文内のキーは受信した内容のままです。 | |
| 受信したHTTPヘッダー。user-agentなどが含まれます。 | |
| Webhook URLに付与されたクエリパラメーター。付与されていない場合は空のオブジェクトです。 | |
| 受信したHTTPメソッド。提供される場合に利用できます。 | |
| サーバーが保存した未加工の本文。送信形式やサーバーの処理によって含まれない場合があります。 |
- が と完全一致するリクエストのみ出力します。一致しない場合はフローに渡すデータを返しません。
- 出力は通知本文だけでなく受信リクエスト全体です。後続で通知内容を利用するときは、 の中から必要な項目を選びます。書類詳細や署名済みファイルを自動で追加取得する処理はありません。
- テスト用の固定サンプルは空のオブジェクトです。通知本文の項目を確認するには、対象の通知を実際に受信してテストデータを確認してください。
クラウドサイン管理画面での設定手順
- クラウドサイン管理画面 にアクセスします。
- 「チーム設定」>「Webhook」セクションで「Webhookを追加」をクリックします。
- フローを有効化後に表示されるWebhook URLを「URL」欄に貼り付けます。
- 通知条件(イベント)を選択します。
- 保存します。
テスト方法
- フローをトリガーせずにサンプルデータを生成する場合は、Webhook URLに を追加してください。
補足
- このトリガーは、リクエストの が の場合のみ処理します。