次の方法で共有

SignatureAPI

署名用のドキュメントを送信し、進行状況を追跡し、自動化用に構築された電子署名プラットフォームである SignatureAPI を使用して作業を迅速に完了します。 https://signatureapi.com/docs/integrations/power-automate/getting-started

このコネクタは、次の製品とリージョンで使用できます。

サービス クラス リージョン
コピロット スタジオ Premium 次を除くすべての Power Automate リージョン :
     - 米国政府 (GCC)
     - 米国政府 (GCC High)
     - 21Vianet が運営する China Cloud
     - 米国国防総省 (DoD)
ロジック アプリ Standard 次を除くすべての Logic Apps リージョン :
     - Azure Government リージョン
     - Azure China リージョン
     - 米国国防総省 (DoD)
Power Apps Premium 次を除くすべての Power Apps リージョン :
     - 米国政府 (GCC)
     - 米国政府 (GCC High)
     - 21Vianet が運営する China Cloud
     - 米国国防総省 (DoD)
Power Automate Premium 次を除くすべての Power Automate リージョン :
     - 米国政府 (GCC)
     - 米国政府 (GCC High)
     - 21Vianet が運営する China Cloud
     - 米国国防総省 (DoD)
お問い合わせ
名前 Signature API, Inc.
URL https://signatureapi.com
Email support@signatureapi.com
コネクタ メタデータ
Publisher SignatureAPI
Website https://signatureapi.com/power-automate
プライバシー ポリシー https://signatureapi.com/privacy
カテゴリ コラボレーション;生産性

SignatureAPI

SignatureAPI は、 自動化のために構築された電子署名プラットフォームです。

Power Automate の電子署名プラットフォームを使用して、署名用のドキュメントを送信し、進行状況を追跡します。このプラットフォームでは、単純なワークフローと複雑なワークフローの両方を作成するのに役立つさまざまなアクションとトリガーが提供されます。

SignatureAPI で作成された電子署名は、ほとんどの管轄区域の従来のインク署名と同様に、法的に拘束力があり、グローバルに受け入れられます。

SignatureAPI は、大量の自動化に対してコスト効率の高い価格を提供します。 価格の詳細を参照してください。

主な機能

  • 複数の受信者: 1 回のトランザクションで最大 10 人の署名者にドキュメントを送信します。
  • 並列署名または順次署名: 一度に、または特定の順序ですべての受信者にドキュメントを送信することを選択します。
  • ドキュメント テンプレート: テンプレートと動的データを使用してプログラムでドキュメントを生成します。
  • 言語とローカライズ: さまざまな言語、日時形式、タイム ゾーンを使用して署名インターフェイスをカスタマイズします。
  • アカウントレス署名: 受信者がアカウントを作成したり、アカウントにログインしたりせずにドキュメントに署名できるようにします。
  • 監査ログ: ドキュメント アクセス、レビュー、署名イベントの詳細なログを保持します。
  • 改ざん防止: 検証済みの反証可能な署名後の文書の整合性を確保します。
  • エンベロープの追跡: わかりやすいダッシュボードを使用して署名の進行状況を監視します。
  • Real-Time 通知: 電子メールと Webhook を使用して、署名アクティビティの即時更新を受信します。

[前提条件]

このコネクタを使用するには、SignatureAPI アカウントにサインアップし、API キーを生成します。 無料のテスト API キーを取得し、接続を設定します。

はじめに

最も一般的なワークフローでは、署名のために 1 つ以上のドキュメントを受信者に送信します。 受信者は、署名インターフェイスにアクセスするためのリンクを含む電子メールを受信します。

SignatureAPI では、高度なワークフローがサポートされています。 詳細な手順、ユース ケース、自動化戦略については、 コネクタ ガイド を参照してください。

手順 1: 封筒を作成する

まず、空の封筒を作成します。 エンベロープは、ドキュメントを保持し、署名プロセスを管理するコンテナーです。

オプションは次のとおりです。

手順 2: 受信者を追加する

封筒に受信者を追加して、ドキュメントに署名する必要があるユーザーを指定します。 現在、署名者のみがサポートされていますが、今後、追加の受信者の種類を使用できるようになります。

手順 3: ドキュメントを追加する

署名が必要なドキュメントを封筒に追加します。 PDF または DOCX ファイルをアップロードしたり、データを使用してテンプレートからドキュメントを生成したりできます。

手順 4: ドキュメント内の場所を定義する

場所は、署名、イニシャルの指定、テキストの追加など、受信者がやり取りするドキュメント内の指定された領域です。 また、完了日などの静的または計算された値を含めることもできます。

手順 5: 署名プロセスを開始する

封筒が完全に準備されたら、署名プロセスを開始します。

手順 6: 封筒が完了するのを待つ

ワークフロー全体を同じフロー内に保持するには、エンベロープが完了するまで待ちます。 これにより、すべての受信者が署名され、成果物 (署名済みドキュメント) が生成されます。

または、エンベロープが完了し、成果物が生成されたときに、別のワークフローをトリガーすることもできます。

手順 7: 署名されたドキュメントを取得する

プロセスが完了したら、署名されたドキュメント (成果物) を取得します。

トリガーの操作

SignatureAPI には、ワークフローを自動化し、プロセスを合理化するためのトリガーが用意されています。 トリガーの完全な一覧とその使用方法について説明します。

一般的に使用されるトリガー

成果物が生成されたとき

封筒が完成し、署名されたドキュメント (成果物) の準備ができたときにトリガーされます。

受信者が封筒を完成した場合

受信者が署名プロセスの一部を完了するたびにトリガーされます。

受信者の電子メールがバウンスする場合

受信者のメール アドレスが要求を受信できない場合にトリガーされます。

既知の問題と制限事項

一般的なエラーと解決策

  • [封筒を待つ] アクションの後に [成果物を取得する] アクションが実行されていることを確認します。 成果物は、すべての受信者がそのパートを完了した後にのみ使用できます。
  • テスト API キーからライブ API キーに切り替える場合は、トリガーを更新して、Webhook が正しい環境 (ライブまたはテスト) に作成されていることを確認します。 詳細については 、トラブルシューティング ガイド を参照してください。

接続を作成する

コネクタでは、次の認証の種類がサポートされています。
デフォルト 接続を作成するためのパラメーター。 すべてのリージョン 共有不可

デフォルト

適用対象: すべてのリージョン

接続を作成するためのパラメーター。

これは共有可能な接続ではありません。 電源アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。

名前 タイプ Description 必須
API キー securestring SignatureAPI アカウントの API キー。 正しい

調整制限

名前 呼び出し 更新期間
接続ごとの API 呼び出し 100 60 秒

アクション

キャプチャされた値を取得する

署名時に入力場所で受信者が入力した値を取得します。 https://signatureapi.com/docs/integrations/power-automate/actions/get-capture
テンプレートにデータを追加する

テンプレートにデータを追加します。 https://signatureapi.com/docs/integrations/power-automate/actions/add-template-data
テンプレートの追加 — DOCX

封筒に DOCX テンプレートを追加します。 https://signatureapi.com/docs/integrations/power-automate/actions/add-template
ドキュメントの追加 — DOCX

封筒に DOCX ドキュメントを追加します。 https://signatureapi.com/docs/integrations/power-automate/actions/add-document-docx
ドキュメントを追加する — PDF

PDF ドキュメントを封筒に追加します。 https://signatureapi.com/docs/integrations/power-automate/actions/add-document
受信者の追加 - 署名者

封筒に受信者を追加します。 https://signatureapi.com/docs/integrations/power-automate/actions/add-recipient
受信者を取得する

受信者の詳細を ID で取得します。 https://signatureapi.com/docs/integrations/power-automate/actions/get-recipient
場所を追加する - イニシャル

文書にイニシャルの場所を追加します。 https://signatureapi.com/docs/integrations/power-automate/actions/add-initials-place
場所を追加する - テキスト

文書にテキストの場所を追加します。 https://signatureapi.com/docs/integrations/power-automate/actions/add-text-place
場所を追加する - テキスト入力

テキスト入力場所を文書に追加します。 https://signatureapi.com/docs/integrations/power-automate/actions/add-text-input-place
場所を追加する - 受信者の完了日

受信者が完了した日付の場所をドキュメントに追加します。 https://signatureapi.com/docs/integrations/power-automate/actions/add-recipient-completed-date-place
場所を追加する - 署名

文書に署名の場所を追加します。 https://signatureapi.com/docs/integrations/power-automate/actions/add-signature-place
場所を追加する — 封筒の完了日

封筒の完成した日付の場所を文書に追加します。 https://signatureapi.com/docs/integrations/power-automate/actions/add-envelope-completed-date-place
封筒を作成する

受信者とドキュメントを追加できる新しい封筒を作成します。 準備ができたら、[封筒の開始] アクションを使用して署名プロセスを開始します。 https://signatureapi.com/docs/integrations/power-automate/actions/create-envelope
封筒を削除する

封筒とすべての関連情報を削除します。 https://signatureapi.com/docs/integrations/power-automate/actions/delete-envelope
封筒を取得する

封筒の詳細を ID で取得します。 https://signatureapi.com/docs/integrations/power-automate/actions/get-envelope
封筒を待つ

エンベロープが完了状態または別の最終状態になるまで待機します。 https://signatureapi.com/docs/integrations/power-automate/actions/wait-envelope
封筒を開始する

封筒の署名プロセスを開始します。 https://signatureapi.com/docs/integrations/power-automate/actions/start-envelope
式を作成する - 電子メール リンク認証

受信者がメールに送信されたリンクを使用して認証される式を作成します。 https://signatureapi.com/docs/integrations/power-automate/actions/create-ceremony-email-link
式を作成する — カスタム認証

受信者が SignatureAPI の外部で認証される式を作成します。 これを使用して、受信者と共有するための式の URL を取得します。 カスタム認証を使用する前に読み取り https://signatureapi.com/docs/integrations/power-automate/actions/create-ceremony-custom
成果物を取得する

ID を使用して成果物を取得します。 封筒の署名されたコピーをダウンロードするために使用します。 https://signatureapi.com/docs/integrations/power-automate/actions/get-deliverable

キャプチャされた値を取得する

操作 ID:
GetCapture

署名時に入力場所で受信者が入力した値を取得します。 https://signatureapi.com/docs/integrations/power-automate/actions/get-capture

パラメーター

名前 キー 必須 型 説明
封筒 ID
 envelopeId True string

封筒の ID。
キャプチャ キー
 captureKey True string

キャプチャされた値のキー。

戻り値

Body
Capture

テンプレートにデータを追加する

操作 ID:
AddTemplateData

テンプレートにデータを追加します。 https://signatureapi.com/docs/integrations/power-automate/actions/add-template-data

パラメーター

名前 キー 必須 型 説明
ドキュメント ID
 documentId True string

ドキュメントの ID。
フィールド名
 field_name True string

テンプレート内のフィールドの名前。
価値
 value True string

テンプレート内のフィールドの値。

テンプレートの追加 — DOCX

操作 ID:
AddTemplate

封筒に DOCX テンプレートを追加します。 https://signatureapi.com/docs/integrations/power-automate/actions/add-template

パラメーター

名前 キー 必須 型 説明
封筒 ID
 envelopeId True string

封筒の ID。
ドキュメント タイトル
 title string

このドキュメントのタイトル。 これは受信者に表示される場合があります。
ファイル コンテンツ
 file_content True byte

ドキュメント ファイルの内容。
テンプレート データ
 data array of string

フィールド: テンプレートに入力するデータを含む値ペア。
その他のプロパティ
 extra string

機能拡張のための追加のプロパティ

戻り値

Body
AddDocumentOutput

ドキュメントの追加 — DOCX

操作 ID:
AddDocumentDocx

封筒に DOCX ドキュメントを追加します。 https://signatureapi.com/docs/integrations/power-automate/actions/add-document-docx

パラメーター

名前 キー 必須 型 説明
封筒 ID
 envelopeId True string

封筒の ID。
ドキュメント タイトル
 title string

このドキュメントのタイトル。 これは受信者に表示される場合があります。
ファイル コンテンツ
 file_content True byte

ドキュメント ファイルの内容。
その他のプロパティ
 extra string

機能拡張のための追加のプロパティ

戻り値

Body
AddDocumentOutput

ドキュメントを追加する — PDF

操作 ID:
AddDocument

PDF ドキュメントを封筒に追加します。 https://signatureapi.com/docs/integrations/power-automate/actions/add-document

パラメーター

名前 キー 必須 型 説明
封筒 ID
 envelopeId True string

封筒の ID。
ドキュメント タイトル
 title string

このドキュメントのタイトル。 これは受信者に表示される場合があります。
ファイル コンテンツ
 file_content True byte

ドキュメント ファイルの内容。
その他のプロパティ
 extra string

機能拡張のための追加のプロパティ

戻り値

Body
AddDocumentOutput

受信者の追加 - 署名者

操作 ID:
AddRecipient

封筒に受信者を追加します。 https://signatureapi.com/docs/integrations/power-automate/actions/add-recipient

パラメーター

名前 キー 必須 型 説明
封筒 ID
 envelopeId True string

封筒の ID。
受信者名
 name True string

受信者の名前。
受信者の電子メール
 email True string

受信者のメール アドレス。
受信者キー
 key True string

封筒内の受信者を識別するキー。
受け取り式の作成
 ceremony_creation string

受信者の儀式を作成する方法。
受信者の配信の種類
 delivery_type string

成果物を受信者に送信する方法。
その他のプロパティ
 extra string

機能拡張のための追加のプロパティ

戻り値

Body
AddRecipientSignerOutput

受信者を取得する

操作 ID:
GetRecipient

受信者の詳細を ID で取得します。 https://signatureapi.com/docs/integrations/power-automate/actions/get-recipient

パラメーター

名前 キー 必須 型 説明
受信者 ID
 recipientId True string

受信者の ID。

戻り値

Body
Recipient

場所を追加する - イニシャル

操作 ID:
AddPlaceInitials

文書にイニシャルの場所を追加します。 https://signatureapi.com/docs/integrations/power-automate/actions/add-initials-place

パラメーター

名前 キー 必須 型 説明
ドキュメント ID
 documentId True string

ドキュメントの ID。
キーを配置する
 key True string

ドキュメント内のこの場所を識別するキー。
受信者キー
 recipient_key True string

この場所が参照する受信者のキー。
高さを配置する
 height number

カスタムの高さを設定すると、幅が比例して調整されます。
ページ番号
 page number

この場所を配置するページ番号。
上からの距離
 top number

ページの上部から場所の下部までの距離 (ポイント単位)。
左からの距離
 left number

ページの左側から場所までの距離 (ポイント単位)。
その他のプロパティ
 extra string

機能拡張のための追加のプロパティ

場所を追加する - テキスト

操作 ID:
AddPlaceText

文書にテキストの場所を追加します。 https://signatureapi.com/docs/integrations/power-automate/actions/add-text-place

パラメーター

名前 キー 必須 型 説明
ドキュメント ID
 documentId True string

ドキュメントの ID。
キーを配置する
 key True string

ドキュメント内のこの場所を識別するキー。
価値
 value True string

このテキストの場所の値。
フォント サイズ
 font_size number

フォント サイズをポイント単位で指定します。
フォントの色
 font_color string

フォントの色 (16 進数表記)。
ページ番号
 page number

この場所を配置するページ番号。
上からの距離
 top number

ページの上部から場所の下部までの距離 (ポイント単位)。
左からの距離
 left number

ページの左側から場所までの距離 (ポイント単位)。
その他のプロパティ
 extra string

機能拡張のための追加のプロパティ

場所を追加する - テキスト入力

操作 ID:
AddPlaceTextInput

テキスト入力場所を文書に追加します。 https://signatureapi.com/docs/integrations/power-automate/actions/add-text-input-place

パラメーター

名前 キー 必須 型 説明
ドキュメント ID
 documentId True string

ドキュメントの ID。
キーを配置する
 key True string

ドキュメント内のこの場所を識別するキー。
受信者キー
 recipient_key True string

この場所が参照する受信者のキー。
Capture As
 capture_as string

受信者の入力を格納し、エンベロープ キャプチャに含まれるキー。
Hint
 hint string

受信者の入力フィールドに表示されるヒント メッセージ。
Prompt
 prompt string

署名式中に入力テキスト フィールド内に表示されるプレースホルダー メッセージ。
Requirement
 requirement string

署名式を完了するために受信者がこのフィールドに入力する必要があるかどうかを指定します。
Format
 format string

ユーザー入力の有効な形式を指定します。 使用できる値については、ドキュメントを参照してください。
メッセージの書式設定
 format_message string

ユーザーの入力が必要な形式と一致しない場合に表示されるメッセージ。
ページ番号
 page number

この場所を配置するページ番号。
上からの距離
 top number

ページの上部から場所の下部までの距離 (ポイント単位)。
左からの距離
 left number

ページの左側から場所までの距離 (ポイント単位)。
その他のプロパティ
 extra string

機能拡張のための追加のプロパティ

場所を追加する - 受信者の完了日

操作 ID:
AddPlaceRecipientCompletedDate

受信者が完了した日付の場所をドキュメントに追加します。 https://signatureapi.com/docs/integrations/power-automate/actions/add-recipient-completed-date-place

パラメーター

名前 キー 必須 型 説明
ドキュメント ID
 documentId True string

ドキュメントの ID。
キーを配置する
 key True string

ドキュメント内のこの場所を識別するキー。
受信者キー
 recipient_key True string

この場所が参照する受信者のキー。
日付形式
 date_format string

日付と時刻の形式を定義します。 使用できる値については、ドキュメントを参照してください。
ページ番号
 page number

この場所を配置するページ番号。
上からの距離
 top number

ページの上部から場所の下部までの距離 (ポイント単位)。
左からの距離
 left number

ページの左側から場所までの距離 (ポイント単位)。
その他のプロパティ
 extra string

機能拡張のための追加のプロパティ

場所を追加する - 署名

操作 ID:
AddPlaceSignature

文書に署名の場所を追加します。 https://signatureapi.com/docs/integrations/power-automate/actions/add-signature-place

パラメーター

名前 キー 必須 型 説明
ドキュメント ID
 documentId True string

ドキュメントの ID。
キーを配置する
 key True string

ドキュメント内のこの場所を識別するキー。
受信者キー
 recipient_key True string

この場所が参照する受信者のキー。
高さを配置する
 height number

カスタムの高さを設定すると、幅が比例して調整されます。
ページ番号
 page number

この場所を配置するページ番号。
上からの距離
 top number

ページの上部から場所の下部までの距離 (ポイント単位)。
左からの距離
 left number

ページの左側から場所までの距離 (ポイント単位)。
その他のプロパティ
 extra string

機能拡張のための追加のプロパティ

場所を追加する — 封筒の完了日

操作 ID:
AddPlaceEnvelopeCompletedDate

封筒の完成した日付の場所を文書に追加します。 https://signatureapi.com/docs/integrations/power-automate/actions/add-envelope-completed-date-place

パラメーター

名前 キー 必須 型 説明
ドキュメント ID
 documentId True string

ドキュメントの ID。
キーを配置する
 key True string

ドキュメント内のこの場所を識別するキー。
日付形式
 date_format string

日付と時刻の形式を定義します。 使用できる値については、ドキュメントを参照してください。
ページ番号
 page number

この場所を配置するページ番号。
上からの距離
 top number

ページの上部から場所の下部までの距離 (ポイント単位)。
左からの距離
 left number

ページの左側から場所までの距離 (ポイント単位)。
その他のプロパティ
 extra string

機能拡張のための追加のプロパティ

封筒を作成する

操作 ID:
CreateEnvelope

受信者とドキュメントを追加できる新しい封筒を作成します。 準備ができたら、[封筒の開始] アクションを使用して署名プロセスを開始します。 https://signatureapi.com/docs/integrations/power-automate/actions/create-envelope

パラメーター

名前 キー 必須 型 説明
封筒のタイトル
 title True string

この封筒のタイトル。 これは受信者に表示される場合があります。
封筒ラベル
 label string

識別しやすくするために封筒に付けられたカスタム ラベル。 ラベルは内部で使用するため、受信者には表示されません。
封筒メッセージ
 message string

受信者に送信されるメッセージ。
封筒モード
 mode string

テスト モードエンベロープはバインドされず、課金されません。
エンベロープ ルーティング
 routing string

受信者が封筒に署名する順序。 並列で、すべての受信者が同時に署名できる場合と、受信者が順番に署名できる場合があります。
Language
 language string

署名式と成果物で使用される既定の言語。 指定しない場合は、アカウントの既定の言語が使用されます。 https://signatureapi.com/docs/localization/language
タイム ゾーン
 timezone string

成果物のタイムスタンプに使用するタイム ゾーン。 指定しない場合は、アカウントの既定のタイムゾーン オフセットが使用されます。 https://signatureapi.com/docs/localization/timezone
タイムスタンプ形式
 timestamp_format string

成果物のタイムスタンプで使用される日付と時刻の形式。 指定しない場合は、アカウントの既定のタイムスタンプ形式が使用されます。 https://signatureapi.com/docs/localization/timestamp_format
封筒構成証明
 attestation string

規制またはコンプライアンスの構成証明
名前
 name string

送信者の名前。
Email
 email string

送信者のメール アドレス。
封筒に関するトピック
 topics array of string

エンベロープを分類し、Webhook 通知をフィルター処理するために使用します。
その他のプロパティ
 extra string

機能拡張のための追加のプロパティ

戻り値

Body
CreateEnvelopeOutput

封筒を削除する

操作 ID:
DeleteEnvelope

封筒とすべての関連情報を削除します。 https://signatureapi.com/docs/integrations/power-automate/actions/delete-envelope

パラメーター

名前 キー 必須 型 説明
封筒 ID
 envelopeId True string

封筒の ID。

封筒を取得する

操作 ID:
GetEnvelope

封筒の詳細を ID で取得します。 https://signatureapi.com/docs/integrations/power-automate/actions/get-envelope

パラメーター

名前 キー 必須 型 説明
封筒 ID
 envelopeId True string

封筒の ID。

戻り値

Body
Envelope

封筒を待つ

操作 ID:
WaitEnvelope

エンベロープが完了状態または別の最終状態になるまで待機します。 https://signatureapi.com/docs/integrations/power-automate/actions/wait-envelope

パラメーター

名前 キー 必須 型 説明
封筒 ID
 envelopeId True string

封筒の ID。

戻り値

Body
Envelope

封筒を開始する

操作 ID:
StartEnvelope

封筒の署名プロセスを開始します。 https://signatureapi.com/docs/integrations/power-automate/actions/start-envelope

パラメーター

名前 キー 必須 型 説明
封筒 ID
 envelopeId True string

封筒の ID。

戻り値

Body
StartEnvelopeOutput

式を作成する - 電子メール リンク認証

操作 ID:
CreateCeremonyEmailLink

受信者がメールに送信されたリンクを使用して認証される式を作成します。 https://signatureapi.com/docs/integrations/power-automate/actions/create-ceremony-email-link

パラメーター

名前 キー 必須 型 説明
受信者 ID
 recipientId True string

受信者の ID。
リダイレクト URL
 redirect_url string

式が完了した後に受信者をリダイレクトする URL。 詳細については、以下を参照してください。 https://signatureapi.com/docs/resources/ceremonies/redirect-url
その他のプロパティ
 extra string

機能拡張のための追加のプロパティ

戻り値

response
object

式を作成する — カスタム認証

操作 ID:
CreateCeremonyCustom

受信者が SignatureAPI の外部で認証される式を作成します。 これを使用して、受信者と共有するための式の URL を取得します。 カスタム認証を使用する前に読み取り https://signatureapi.com/docs/integrations/power-automate/actions/create-ceremony-custom

パラメーター

名前 キー 必須 型 説明
受信者 ID
 recipientId True string

受信者の ID。
認証プロバイダー
 provider True string

認証プロバイダーの名前。 この値は任意であり、エンベロープの監査ログに表示されます。
認証データ
 data True array of string

キー: 認証メタデータを含む値ペア。 これらの詳細は、エンベロープの監査ログに含まれます。
リダイレクト URL
 redirect_url string

式が完了した後に受信者をリダイレクトする URL。 詳細については、以下を参照してください。 https://signatureapi.com/docs/resources/ceremonies/redirect-url
その他のプロパティ
 extra string

機能拡張のための追加のプロパティ

戻り値

Body
CreateCeremonyCustomOutput

成果物を取得する

操作 ID:
GetDeliverable

ID を使用して成果物を取得します。 封筒の署名されたコピーをダウンロードするために使用します。 https://signatureapi.com/docs/integrations/power-automate/actions/get-deliverable

パラメーター

名前 キー 必須 型 説明
成果物 ID
 deliverableId True string

成果物の ID。

戻り値

Body
Deliverable

トリガー

受信者がバウンスしたとき

このイベントは、メールが一時的 (ソフトバウンス) または永続的 (ハードバウンス) のいずれかの配信不能である場合に発生します。
受信者が再送信されたとき

このイベントは、要求が受信者に再送信されるときに発生します。
受信者が失敗した場合

このイベントは、受信者に関連するエラーが発生し、受信者の状態が失敗した場合に発生します。
受信者が完了したとき

このイベントは、受信者が署名プロセスの一部を完了したときに発生します。
受信者が拒否されたとき

このイベントは、受信者が封筒を拒否したときに発生します。
受信者が置き換えられる場合

このイベントは、受信者が新しい受信者に置き換えられたときに発生します。
受信者が解放されたとき

このイベントは、受信者が封筒を完成させる要求を送信する準備ができたときに発生します。
受信者が送信されたとき

このイベントは、要求が受信者に送信されるときに発生します。
封筒が作成されたとき

このイベントは、エンベロープが作成されるたびに発生します。
封筒が取り消されたとき

このイベントは、署名プロセスが完了前に意図的に停止され、エンベロープの状態が取り消された場合に発生します。
封筒が失敗した場合

このイベントは、エンベロープが失敗し、エンベロープの状態が失敗した場合に発生します。
封筒が完成したとき

このイベントは、封筒の状態がin_progressから完了に遷移し、すべての受信者によって完了されたことを示す場合に発生します。
封筒が開始されたとき

このイベントは、エンベロープの状態が処理からin_progressに移行し、受信者に送信する準備ができている場合に発生します。
成果物が失敗した場合

このイベントは、成果物の生成が失敗し、成果物の状態が失敗した場合に発生します。
成果物が生成されたとき

このイベントは、監査ログなどの成果物が正常に生成されたときに発生します。

受信者がバウンスしたとき

操作 ID:
CreateEndpointForRecipientBounced

このイベントは、メールが一時的 (ソフトバウンス) または永続的 (ハードバウンス) のいずれかの配信不能である場合に発生します。

パラメーター

名前 キー 必須 型 説明
トピック
 topics array of string

エンベロープを分類し、Webhook 通知をフィルター処理するために使用します。

戻り値

Body
NotificationForRecipientBounced

受信者が再送信されたとき

操作 ID:
CreateEndpointForRecipientResent

このイベントは、要求が受信者に再送信されるときに発生します。

パラメーター

名前 キー 必須 型 説明
トピック
 topics array of string

エンベロープを分類し、Webhook 通知をフィルター処理するために使用します。

戻り値

Body
NotificationForRecipientResent

受信者が失敗した場合

操作 ID:
CreateEndpointForRecipientFailed

このイベントは、受信者に関連するエラーが発生し、受信者の状態が失敗した場合に発生します。

パラメーター

名前 キー 必須 型 説明
トピック
 topics array of string

エンベロープを分類し、Webhook 通知をフィルター処理するために使用します。

戻り値

Body
NotificationForRecipientFailed

受信者が完了したとき

操作 ID:
CreateEndpointForRecipientCompleted

このイベントは、受信者が署名プロセスの一部を完了したときに発生します。

パラメーター

名前 キー 必須 型 説明
トピック
 topics array of string

エンベロープを分類し、Webhook 通知をフィルター処理するために使用します。

戻り値

Body
NotificationForRecipientCompleted

受信者が拒否されたとき

操作 ID:
CreateEndpointForRecipientRejected

このイベントは、受信者が封筒を拒否したときに発生します。

パラメーター

名前 キー 必須 型 説明
トピック
 topics array of string

エンベロープを分類し、Webhook 通知をフィルター処理するために使用します。

戻り値

Body
NotificationForRecipientRejected

受信者が置き換えられる場合

操作 ID:
CreateEndpointForRecipientReplaced

このイベントは、受信者が新しい受信者に置き換えられたときに発生します。

パラメーター

名前 キー 必須 型 説明
トピック
 topics array of string

エンベロープを分類し、Webhook 通知をフィルター処理するために使用します。

戻り値

Body
NotificationForRecipientReplaced

受信者が解放されたとき

操作 ID:
CreateEndpointForRecipientReleased

このイベントは、受信者が封筒を完成させる要求を送信する準備ができたときに発生します。

パラメーター

名前 キー 必須 型 説明
トピック
 topics array of string

エンベロープを分類し、Webhook 通知をフィルター処理するために使用します。

戻り値

Body
NotificationForRecipientReleased

受信者が送信されたとき

操作 ID:
CreateEndpointForRecipientSent

このイベントは、要求が受信者に送信されるときに発生します。

パラメーター

名前 キー 必須 型 説明
トピック
 topics array of string

エンベロープを分類し、Webhook 通知をフィルター処理するために使用します。

戻り値

Body
NotificationForRecipientSent

封筒が作成されたとき

操作 ID:
CreateEndpointForEnvelopeCreated

このイベントは、エンベロープが作成されるたびに発生します。

パラメーター

名前 キー 必須 型 説明
トピック
 topics array of string

エンベロープを分類し、Webhook 通知をフィルター処理するために使用します。

戻り値

Body
NotificationForEnvelopeCreated

封筒が取り消されたとき

操作 ID:
CreateEndpointForEnvelopeCanceled

このイベントは、署名プロセスが完了前に意図的に停止され、エンベロープの状態が取り消された場合に発生します。

パラメーター

名前 キー 必須 型 説明
トピック
 topics array of string

エンベロープを分類し、Webhook 通知をフィルター処理するために使用します。

戻り値

Body
NotificationForEnvelopeCanceled

封筒が失敗した場合

操作 ID:
CreateEndpointForEnvelopeFailed

このイベントは、エンベロープが失敗し、エンベロープの状態が失敗した場合に発生します。

パラメーター

名前 キー 必須 型 説明
トピック
 topics array of string

エンベロープを分類し、Webhook 通知をフィルター処理するために使用します。

戻り値

Body
NotificationForEnvelopeFailed

封筒が完成したとき

操作 ID:
CreateEndpointForEnvelopeCompleted

このイベントは、封筒の状態がin_progressから完了に遷移し、すべての受信者によって完了されたことを示す場合に発生します。

パラメーター

名前 キー 必須 型 説明
トピック
 topics array of string

エンベロープを分類し、Webhook 通知をフィルター処理するために使用します。

戻り値

Body
NotificationForEnvelopeCompleted

封筒が開始されたとき

操作 ID:
CreateEndpointForEnvelopeStarted

このイベントは、エンベロープの状態が処理からin_progressに移行し、受信者に送信する準備ができている場合に発生します。

パラメーター

名前 キー 必須 型 説明
トピック
 topics array of string

エンベロープを分類し、Webhook 通知をフィルター処理するために使用します。

戻り値

Body
NotificationForEnvelopeStarted

成果物が失敗した場合

操作 ID:
CreateEndpointForDeliverableFailed

このイベントは、成果物の生成が失敗し、成果物の状態が失敗した場合に発生します。

パラメーター

名前 キー 必須 型 説明
トピック
 topics array of string

エンベロープを分類し、Webhook 通知をフィルター処理するために使用します。

戻り値

Body
NotificationForDeliverableFailed

成果物が生成されたとき

操作 ID:
CreateEndpointForDeliverableGenerated

このイベントは、監査ログなどの成果物が正常に生成されたときに発生します。

パラメーター

名前 キー 必須 型 説明
トピック
 topics array of string

エンベロープを分類し、Webhook 通知をフィルター処理するために使用します。

戻り値

Body
NotificationForDeliverableGenerated

定義

Envelope

名前 パス 型 説明
封筒 ID
 id EnvelopeId

封筒の ID。
封筒のタイトル
 title EnvelopeTitle

この封筒のタイトル。 これは受信者に表示される場合があります。
封筒ラベル
 label EnvelopeLabel

識別しやすくするために封筒に付けられたカスタム ラベル。 ラベルは内部で使用するため、受信者には表示されません。
封筒メッセージ
 message EnvelopeMessage

受信者に送信されるメッセージ。
センダー
 sender EnvelopeSender
封筒の状態
 status EnvelopeStatus

封筒の状態。
成果物
 deliverable EnvelopeDeliverable
封筒の完成日時
 completed_at EnvelopeCompletedAt

すべての受信者が封筒を完了した時刻。
封筒モード
 mode EnvelopeMode

テスト モードエンベロープはバインドされず、課金されません。
エンベロープ ルーティング
 routing EnvelopeRouting

受信者が封筒に署名する順序。 並列で、すべての受信者が同時に署名できる場合と、受信者が順番に署名できる場合があります。
タイム ゾーン
 timezone EnvelopeTimezone

成果物のタイムスタンプに使用するタイム ゾーン。 指定しない場合は、アカウントの既定のタイムゾーン オフセットが使用されます。 https://signatureapi.com/docs/localization/timezone
タイムスタンプ形式
 timestamp_format EnvelopeTimestampFormat

成果物のタイムスタンプで使用される日付と時刻の形式。 指定しない場合は、アカウントの既定のタイムスタンプ形式が使用されます。 https://signatureapi.com/docs/localization/timestamp_format
封筒構成証明
 attestation EnvelopeAttestation

規制またはコンプライアンスの構成証明
封筒に関するトピック
 topics EnvelopeTopics

エンベロープを分類し、Webhook 通知をフィルター処理するために使用します。

Recipient

名前 パス 型 説明
受信者 ID
 id RecipientId

受信者の ID。
封筒 ID
 envelope_id EnvelopeId

封筒の ID。
受信者の種類
 type RecipientType

受信者の種類。
受信者キー
 key RecipientKey

封筒内の受信者を識別するキー。
受信者名
 name RecipientName

受信者の名前。
受信者の電子メール
 email RecipientEmail

受信者のメール アドレス。
受信者の状態
 status RecipientStatus

受信者の状態。
受け取り式の作成
 ceremony_creation RecipientCeremonyCreation

受信者の儀式を作成する方法。
受信者の配信の種類
 delivery_type RecipientDeliveryType

成果物を受信者に送信する方法。
受信者の完了日時
 completed_at RecipientCompletedAt

受信者が封筒を完成した時刻。

成果物

名前 パス 型 説明
成果物 ID
 id DeliverableId

成果物の ID。
成果物の種類
 type DeliverableType

成果物の種類。
成果物の状態
 status DeliverableStatus

成果物の状態。
ファイル コンテンツ
 file_content DeliverableFileContent

成果物のファイル コンテンツ。 封筒の署名されたコピーを保存するために使用します。

Capture

名前 パス 型 説明
キャプチャ値
 value CaptureValue

受信者入力キャプチャの値

CreateEnvelopeOutput

名前 パス 型 説明
封筒 ID
 id EnvelopeId

封筒の ID。
封筒のタイトル
 title EnvelopeTitle

この封筒のタイトル。 これは受信者に表示される場合があります。
封筒ラベル
 label EnvelopeLabel

識別しやすくするために封筒に付けられたカスタム ラベル。 ラベルは内部で使用するため、受信者には表示されません。
封筒メッセージ
 message EnvelopeMessage

受信者に送信されるメッセージ。
センダー
 sender EnvelopeSender
封筒モード
 mode EnvelopeMode

テスト モードエンベロープはバインドされず、課金されません。
エンベロープ ルーティング
 routing EnvelopeRouting

受信者が封筒に署名する順序。 並列で、すべての受信者が同時に署名できる場合と、受信者が順番に署名できる場合があります。
タイム ゾーン
 timezone EnvelopeTimezone

成果物のタイムスタンプに使用するタイム ゾーン。 指定しない場合は、アカウントの既定のタイムゾーン オフセットが使用されます。 https://signatureapi.com/docs/localization/timezone
タイムスタンプ形式
 timestamp_format EnvelopeTimestampFormat

成果物のタイムスタンプで使用される日付と時刻の形式。 指定しない場合は、アカウントの既定のタイムスタンプ形式が使用されます。 https://signatureapi.com/docs/localization/timestamp_format
封筒構成証明
 attestation EnvelopeAttestation

規制またはコンプライアンスの構成証明
封筒に関するトピック
 topics EnvelopeTopics

エンベロープを分類し、Webhook 通知をフィルター処理するために使用します。

StartEnvelopeOutput

名前 パス 型 説明
封筒の状態
 status EnvelopeStatus

封筒の状態。

AddDocumentOutput

名前 パス 型 説明
ドキュメント ID
 id DocumentId

ドキュメントの ID

AddRecipientSignerOutput

名前 パス 型 説明
受信者 ID
 id RecipientId

受信者の ID。
受信者名
 name RecipientName

受信者の名前。
受信者の電子メール
 email RecipientEmail

受信者のメール アドレス。
受信者キー
 key RecipientKey

封筒内の受信者を識別するキー。
受け取り式の作成
 ceremony_creation RecipientCeremonyCreation

受信者の儀式を作成する方法。
受信者の配信の種類
 delivery_type RecipientDeliveryType

成果物を受信者に送信する方法。

CreateCeremonyCustomOutput

名前 パス 型 説明
式の URL
 url CeremonyUrl

受信者が式を開始するためにアクセスする必要がある URL

EnvelopeId

封筒の ID。

封筒の ID。

封筒 ID
string

EnvelopeTitle

この封筒のタイトル。 これは受信者に表示される場合があります。

この封筒のタイトル。 これは受信者に表示される場合があります。

封筒のタイトル
string

EnvelopeLabel

識別しやすくするために封筒に付けられたカスタム ラベル。 ラベルは内部で使用するため、受信者には表示されません。

識別しやすくするために封筒に付けられたカスタム ラベル。 ラベルは内部で使用するため、受信者には表示されません。

封筒ラベル
string

EnvelopeMessage

受信者に送信されるメッセージ。

受信者に送信されるメッセージ。

封筒メッセージ
string

EnvelopeRouting

受信者が封筒に署名する順序。 並列で、すべての受信者が同時に署名できる場合と、受信者が順番に署名できる場合があります。

受信者が封筒に署名する順序。 並列で、すべての受信者が同時に署名できる場合と、受信者が順番に署名できる場合があります。

エンベロープ ルーティング
string

EnvelopeTimezone

成果物のタイムスタンプに使用するタイム ゾーン。 指定しない場合は、アカウントの既定のタイムゾーン オフセットが使用されます。 https://signatureapi.com/docs/localization/timezone

成果物のタイムスタンプに使用するタイム ゾーン。 指定しない場合は、アカウントの既定のタイムゾーン オフセットが使用されます。 https://signatureapi.com/docs/localization/timezone

タイム ゾーン
string

EnvelopeTimestampFormat

成果物のタイムスタンプで使用される日付と時刻の形式。 指定しない場合は、アカウントの既定のタイムスタンプ形式が使用されます。 https://signatureapi.com/docs/localization/timestamp_format

成果物のタイムスタンプで使用される日付と時刻の形式。 指定しない場合は、アカウントの既定のタイムスタンプ形式が使用されます。 https://signatureapi.com/docs/localization/timestamp_format

タイムスタンプ形式
string

EnvelopeSender

名前 パス 型 説明
送信者名
 name string

送信者の名前。
送信者の電子メール
 email string

送信者のメール アドレス。

EnvelopeStatus

封筒の状態。

封筒の状態。

封筒の状態
string

EnvelopeMode

テスト モードエンベロープはバインドされず、課金されません。

テスト モードエンベロープはバインドされず、課金されません。

封筒モード
string

EnvelopeTopics

エンベロープを分類し、Webhook 通知をフィルター処理するために使用します。

名前 パス 型 説明
アイテム
 string

EnvelopeAttestation

規制またはコンプライアンスの構成証明

規制またはコンプライアンスの構成証明

封筒構成証明
string

EnvelopeDeliverable

名前 パス 型 説明
成果物 ID
 id string

成果物の ID。 これを使用して、封筒の署名済みコピーをダウンロードします。

EnvelopeCompletedAt

すべての受信者が封筒を完了した時刻。

すべての受信者が封筒を完了した時刻。

封筒の完成日時
date-time

DocumentId

ドキュメントの ID

ドキュメントの ID

ドキュメント ID
string

RecipientId

受信者の ID。

受信者の ID。

受信者 ID
string

RecipientType

受信者の種類。

受信者の種類。

受信者の種類
string

RecipientName

受信者の名前。

受信者の名前。

受信者名
string

RecipientEmail

受信者のメール アドレス。

受信者のメール アドレス。

受信者の電子メール
string

RecipientKey

封筒内の受信者を識別するキー。

封筒内の受信者を識別するキー。

受信者キー
string

RecipientStatus

受信者の状態。

受信者の状態。

受信者の状態
string

RecipientCeremonyCreation

受信者の儀式を作成する方法。

受信者の儀式を作成する方法。

受け取り式の作成
string

RecipientDeliveryType

成果物を受信者に送信する方法。

成果物を受信者に送信する方法。

受信者の配信の種類
string

RecipientCompletedAt

受信者が封筒を完成した時刻。

受信者が封筒を完成した時刻。

受信者の完了日時
date-time

DeliverableId

成果物の ID。

成果物の ID。

成果物 ID
string

DeliverableType

成果物の種類。

成果物の種類。

成果物の種類
string

DeliverableStatus

成果物の状態。

成果物の状態。

成果物の状態
string

DeliverableFileContent

成果物のファイル コンテンツ。 封筒の署名されたコピーを保存するために使用します。

成果物のファイル コンテンツ。 封筒の署名されたコピーを保存するために使用します。

ファイル コンテンツ
byte

CeremonyUrl

受信者が式を開始するためにアクセスする必要がある URL

受信者が式を開始するためにアクセスする必要がある URL

式の URL
string

CaptureValue

受信者入力キャプチャの値

受信者入力キャプチャの値

キャプチャ値
string

NotificationForEnvelopeCreated

名前 パス 型 説明
イベント ID
 id EventId

イベントの ID。
イベント タイムスタンプ
 timestamp EventTimestamp

ISO 8601 形式のイベントの日付と時刻。
イベントの種類
 type EventType

イベントの種類。
封筒 ID
 data.envelope_id EventEnvelopeId

このイベントが参照するエンベロープの ID。

NotificationForEnvelopeStarted

名前 パス 型 説明
イベント ID
 id EventId

イベントの ID。
イベント タイムスタンプ
 timestamp EventTimestamp

ISO 8601 形式のイベントの日付と時刻。
イベントの種類
 type EventType

イベントの種類。
封筒 ID
 data.envelope_id EventEnvelopeId

このイベントが参照するエンベロープの ID。

NotificationForEnvelopeCompleted

名前 パス 型 説明
イベント ID
 id EventId

イベントの ID。
イベント タイムスタンプ
 timestamp EventTimestamp

ISO 8601 形式のイベントの日付と時刻。
イベントの種類
 type EventType

イベントの種類。
封筒 ID
 data.envelope_id EventEnvelopeId

このイベントが参照するエンベロープの ID。

NotificationForEnvelopeFailed

名前 パス 型 説明
イベント ID
 id EventId

イベントの ID。
イベント タイムスタンプ
 timestamp EventTimestamp

ISO 8601 形式のイベントの日付と時刻。
イベントの種類
 type EventType

イベントの種類。
封筒 ID
 data.envelope_id EventEnvelopeId

このイベントが参照するエンベロープの ID。
Detail
 data.detail string

エラーに関する情報。

NotificationForEnvelopeCanceled

名前 パス 型 説明
イベント ID
 id EventId

イベントの ID。
イベント タイムスタンプ
 timestamp EventTimestamp

ISO 8601 形式のイベントの日付と時刻。
イベントの種類
 type EventType

イベントの種類。
封筒 ID
 data.envelope_id EventEnvelopeId

このイベントが参照するエンベロープの ID。

NotificationForRecipientReleased

名前 パス 型 説明
イベント ID
 id EventId

イベントの ID。
イベント タイムスタンプ
 timestamp EventTimestamp

ISO 8601 形式のイベントの日付と時刻。
イベントの種類
 type EventType

イベントの種類。
封筒 ID
 data.envelope_id EventEnvelopeId

このイベントが参照するエンベロープの ID。
受信者 ID
 data.object_id EventRecipientId

このイベントが参照する受信者の ID。
受信者の種類
 data.recipient_type EventRecipientType

このイベントが参照する受信者の種類。
受信者キー
 data.recipient_key EventRecipientKey

このイベントが参照する受信者のキー。

NotificationForRecipientSent

名前 パス 型 説明
イベント ID
 id EventId

イベントの ID。
イベント タイムスタンプ
 timestamp EventTimestamp

ISO 8601 形式のイベントの日付と時刻。
イベントの種類
 type EventType

イベントの種類。
封筒 ID
 data.envelope_id EventEnvelopeId

このイベントが参照するエンベロープの ID。
受信者 ID
 data.object_id EventRecipientId

このイベントが参照する受信者の ID。
受信者の種類
 data.recipient_type EventRecipientType

このイベントが参照する受信者の種類。
受信者キー
 data.recipient_key EventRecipientKey

このイベントが参照する受信者のキー。

NotificationForRecipientCompleted

名前 パス 型 説明
イベント ID
 id EventId

イベントの ID。
イベント タイムスタンプ
 timestamp EventTimestamp

ISO 8601 形式のイベントの日付と時刻。
イベントの種類
 type EventType

イベントの種類。
封筒 ID
 data.envelope_id EventEnvelopeId

このイベントが参照するエンベロープの ID。
受信者 ID
 data.object_id EventRecipientId

このイベントが参照する受信者の ID。
受信者の種類
 data.recipient_type EventRecipientType

このイベントが参照する受信者の種類。
受信者キー
 data.recipient_key EventRecipientKey

このイベントが参照する受信者のキー。

NotificationForRecipientRejected

名前 パス 型 説明
イベント ID
 id EventId

イベントの ID。
イベント タイムスタンプ
 timestamp EventTimestamp

ISO 8601 形式のイベントの日付と時刻。
イベントの種類
 type EventType

イベントの種類。
封筒 ID
 data.envelope_id EventEnvelopeId

このイベントが参照するエンベロープの ID。
受信者 ID
 data.object_id EventRecipientId

このイベントが参照する受信者の ID。
受信者の種類
 data.recipient_type EventRecipientType

このイベントが参照する受信者の種類。
受信者キー
 data.recipient_key EventRecipientKey

このイベントが参照する受信者のキー。
理由
 data.reason string

拒否に関する受信者の説明。

NotificationForRecipientBounced

名前 パス 型 説明
イベント ID
 id EventId

イベントの ID。
イベント タイムスタンプ
 timestamp EventTimestamp

ISO 8601 形式のイベントの日付と時刻。
イベントの種類
 type EventType

イベントの種類。
封筒 ID
 data.envelope_id EventEnvelopeId

このイベントが参照するエンベロープの ID。
受信者 ID
 data.object_id EventRecipientId

このイベントが参照する受信者の ID。
受信者の種類
 data.recipient_type EventRecipientType

このイベントが参照する受信者の種類。
受信者キー
 data.recipient_key EventRecipientKey

このイベントが参照する受信者のキー。
Detail
 data.detail string

バウンスに関する情報。

NotificationForRecipientFailed

名前 パス 型 説明
イベント ID
 id EventId

イベントの ID。
イベント タイムスタンプ
 timestamp EventTimestamp

ISO 8601 形式のイベントの日付と時刻。
イベントの種類
 type EventType

イベントの種類。
封筒 ID
 data.envelope_id EventEnvelopeId

このイベントが参照するエンベロープの ID。
受信者 ID
 data.object_id EventRecipientId

このイベントが参照する受信者の ID。
受信者の種類
 data.recipient_type EventRecipientType

このイベントが参照する受信者の種類。
受信者キー
 data.recipient_key EventRecipientKey

このイベントが参照する受信者のキー。
Detail
 data.detail string

エラーに関する情報。

NotificationForRecipientReplaced

名前 パス 型 説明
イベント ID
 id EventId

イベントの ID。
イベント タイムスタンプ
 timestamp EventTimestamp

ISO 8601 形式のイベントの日付と時刻。
イベントの種類
 type EventType

イベントの種類。
封筒 ID
 data.envelope_id EventEnvelopeId

このイベントが参照するエンベロープの ID。
受信者 ID
 data.object_id EventRecipientId

このイベントが参照する受信者の ID。
受信者の種類
 data.recipient_type EventRecipientType

このイベントが参照する受信者の種類。
受信者キー
 data.recipient_key EventRecipientKey

このイベントが参照する受信者のキー。
新しい受信者 ID
 data.new_recipient_id string

新しい受信者の ID。

NotificationForRecipientResent

名前 パス 型 説明
イベント ID
 id EventId

イベントの ID。
イベント タイムスタンプ
 timestamp EventTimestamp

ISO 8601 形式のイベントの日付と時刻。
イベントの種類
 type EventType

イベントの種類。
封筒 ID
 data.envelope_id EventEnvelopeId

このイベントが参照するエンベロープの ID。
受信者 ID
 data.object_id EventRecipientId

このイベントが参照する受信者の ID。
受信者の種類
 data.recipient_type EventRecipientType

このイベントが参照する受信者の種類。
受信者キー
 data.recipient_key EventRecipientKey

このイベントが参照する受信者のキー。

NotificationForDeliverableGenerated

名前 パス 型 説明
イベント ID
 id EventId

イベントの ID。
イベント タイムスタンプ
 timestamp EventTimestamp

ISO 8601 形式のイベントの日付と時刻。
イベントの種類
 type EventType

イベントの種類。
封筒 ID
 data.envelope_id EventEnvelopeId

このイベントが参照するエンベロープの ID。
成果物 ID
 data.object_id EventDeliverableId

このイベントが参照する成果物の ID。

NotificationForDeliverableFailed

名前 パス 型 説明
イベント ID
 id EventId

イベントの ID。
イベント タイムスタンプ
 timestamp EventTimestamp

ISO 8601 形式のイベントの日付と時刻。
イベントの種類
 type EventType

イベントの種類。
封筒 ID
 data.envelope_id EventEnvelopeId

このイベントが参照するエンベロープの ID。
成果物 ID
 data.object_id EventDeliverableId

このイベントが参照する成果物の ID。
Detail
 data.detail string

エラーに関する情報。

EventId

イベントの ID。

イベントの ID。

イベント ID
string

イベントタイムスタンプ

ISO 8601 形式のイベントの日付と時刻。

ISO 8601 形式のイベントの日付と時刻。

イベント タイムスタンプ
date-time

イベントの種類

イベントの種類。

イベントの種類。

イベントの種類
string

EventEnvelopeId

このイベントが参照するエンベロープの ID。

このイベントが参照するエンベロープの ID。

封筒 ID
string

EventRecipientId

このイベントが参照する受信者の ID。

このイベントが参照する受信者の ID。

受信者 ID
string

EventRecipientType

このイベントが参照する受信者の種類。

このイベントが参照する受信者の種類。

受信者の種類
string

EventRecipientKey

このイベントが参照する受信者のキー。

このイベントが参照する受信者のキー。

受信者キー
string

EventDeliverableId

このイベントが参照する成果物の ID。

このイベントが参照する成果物の ID。

成果物 ID
string

オブジェクト

これは型 'object' です。