Share via

SignatureAPI

  • Reference

Send documents for signing, track their progress, and get work done faster with SignatureAPI, the electronic signature platform built for automation. https://signatureapi.com/docs/integrations/power-automate/getting-started

This connector is available in the following products and regions:

Service Class Regions
Copilot Studio Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Signature API, Inc.
URL https://signatureapi.com
Email [email protected]
Connector Metadata
Publisher SignatureAPI
Website https://signatureapi.com/power-automate
Privacy policy https://signatureapi.com/privacy
Categories Collaboration;Productivity

SignatureAPI

SignatureAPI is an electronic signature platform built for automation.

Send documents for signing and track their progress using our e-signature platform for Power Automate, which provides various actions and triggers to help you create both simple and complex workflows.

Electronic signatures made with SignatureAPI are legally binding and globally accepted, just like traditional ink signatures in most jurisdictions.

SignatureAPI offers cost-effective pricing for high-volume automation. See our pricing details.

Key Features

  • Multiple Recipients: Send documents to up to 10 signers in a single transaction.
  • Parallel or Sequential Signing: Choose to send documents to all recipients at once or in a specific order.
  • Document Templates: Generate documents programmatically using templates and dynamic data.
  • Languages & Localization: Customize the signing interface with different languages, date-time formats, and time zones.
  • Accountless Signing: Allow recipients to sign documents without creating or logging into an account.
  • Audit Log: Maintain a detailed log of document access, review, and signature events.
  • Tamper-Proofing: Ensure document integrity with verified, irrefutable proof post-signature.
  • Track Envelopes: Monitor signing progress through a user-friendly dashboard.
  • Real-Time Notifications: Receive instant updates on signing activities via email and webhooks.

Prerequisites

To use this connector, sign up for a SignatureAPI account and generate an API key. Get a free test API key and set up your connection.

Getting Started

The most common workflow involves sending one or more documents to recipients for signature. The recipients receive an email with a link to access the signing interface.

SignatureAPI supports advanced workflows. Explore our Connector Guides for step-by-step instructions, use cases, and automation strategies.

Step 1: Create an Envelope

Begin by creating an empty envelope. An envelope is a container that holds documents and manages the signing process.

Options include:

Step 2: Add Recipients

Specify who needs to sign the documents by adding recipients to your envelope. Currently, only signers are supported, but additional recipient types will be available in the future.

Step 3: Add Documents

Add the documents that need signatures to the envelope. You can upload PDF or DOCX files or generate documents from templates using data.

Step 4: Define Places in the Documents

Places are designated areas within a document where a recipient interacts, such as signing, providing initials, or adding text. They can also contain static or calculated values like completion dates.

Step 5: Start the Signing Process

Once the envelope is fully prepared, initiate the signing process.

Step 6: Wait for the Envelope to be Completed

To keep the entire workflow within the same flow, you can wait until the envelope is completed. This ensures that all recipients have signed and the deliverable (signed document) is generated.

Alternatively, you can trigger a separate workflow when the envelope is completed and the deliverable is generated.

Step 7: Retrieve the Signed Document

Once the process is complete, retrieve the signed document (deliverable).

Working with Triggers

SignatureAPI offers triggers to automate your workflows and streamline processes. Learn about the full list of triggers and how to use them.

Commonly Used Triggers

When a Deliverable is Generated

Triggered when the envelope is completed and the signed document (deliverable) is ready.

When a Recipient Completes an Envelope

Triggered each time a recipient finishes their part of the signing process.

When a Recipient Email Bounces

Triggered when a recipient's email address cannot receive the request.

Known Issues and Limitations

Common Errors and Solutions

  • Ensure the Get a deliverable action runs after the Wait for envelope action. Deliverables are only available once all recipients have completed their part.
  • If you switch from a test API key to a live API key, update the trigger to ensure the webhook is created in the correct environment (live or test). See our troubleshooting guide for details.

Creating a connection

The connector supports the following authentication types:
Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
API Key securestring The API Key for your SignatureAPI account. True

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Add a document — DOCX

Adds a DOCX document to an envelope. https://signatureapi.com/docs/integrations/power-automate/actions/add-document-docx
Add a document — PDF

Adds a PDF document to an envelope. https://signatureapi.com/docs/integrations/power-automate/actions/add-document
Add a place — Envelope completed date

Adds a envelope completed date place to a document. https://signatureapi.com/docs/integrations/power-automate/actions/add-envelope-completed-date-place
Add a place — Initials

Adds an initials place to a document. https://signatureapi.com/docs/integrations/power-automate/actions/add-initials-place
Add a place — Recipient completed date

Adds a recipient completed date place to a document. https://signatureapi.com/docs/integrations/power-automate/actions/add-recipient-completed-date-place
Add a place — Signature

Adds a signature place to a document. https://signatureapi.com/docs/integrations/power-automate/actions/add-signature-place
Add a place — Text

Adds a text place to a document. https://signatureapi.com/docs/integrations/power-automate/actions/add-text-place
Add a place — Text Input

Adds a text input place to a document. https://signatureapi.com/docs/integrations/power-automate/actions/add-text-input-place
Add a recipient — Signer

Adds a recipient to an envelope. https://signatureapi.com/docs/integrations/power-automate/actions/add-recipient
Add a template — DOCX

Adds a DOCX template to an envelope. https://signatureapi.com/docs/integrations/power-automate/actions/add-template
Add data to template

Adds data to a template. https://signatureapi.com/docs/integrations/power-automate/actions/add-template-data
Create a ceremony — Custom authentication

Creates a ceremony where the recipient is authenticated externally to SignatureAPI. Use this to obtain a ceremony URL for sharing with recipients. Before using custom authentication read https://signatureapi.com/docs/integrations/power-automate/actions/create-ceremony-custom
Create a ceremony — Email link authentication

Creates a ceremony where the recipient is authenticated via a link sent to their email. https://signatureapi.com/docs/integrations/power-automate/actions/create-ceremony-email-link
Create an envelope

Creates a new envelope to which you can add recipients and documents. When ready, use the 'Start an envelope' action to initiate the signing process. https://signatureapi.com/docs/integrations/power-automate/actions/create-envelope
Delete an envelope

Deletes an envelope and all associated information. https://signatureapi.com/docs/integrations/power-automate/actions/delete-envelope
Get a captured value

Retrieves a value entered by a recipient in an input place during signing. https://signatureapi.com/docs/integrations/power-automate/actions/get-capture
Get a deliverable

Retrieves a deliverable using its ID. Use it to download a signed copy of the envelope. https://signatureapi.com/docs/integrations/power-automate/actions/get-deliverable
Get a recipient

Retrieves recipient details by their ID. https://signatureapi.com/docs/integrations/power-automate/actions/get-recipient
Get an envelope

Retrieves envelope details by its ID. https://signatureapi.com/docs/integrations/power-automate/actions/get-envelope
Start an envelope

Initiates the signing process for an envelope. https://signatureapi.com/docs/integrations/power-automate/actions/start-envelope
Wait for envelope

Waits for an envelope to reach a completed state or another final status. https://signatureapi.com/docs/integrations/power-automate/actions/wait-envelope

Add a document — DOCX

Operation ID:
AddDocumentDocx

Adds a DOCX document to an envelope. https://signatureapi.com/docs/integrations/power-automate/actions/add-document-docx

Parameters

Name Key Required Type Description
Envelope ID
 envelopeId True string

The ID of the envelope.
Document Title
 title string

The title of this document. This may be shown to recipients.
File Content
 file_content True byte

The content of the document file.
Extra Properties
 extra string

Extra properties for extensibility

Returns

Body
AddDocumentOutput

Add a document — PDF

Operation ID:
AddDocument

Adds a PDF document to an envelope. https://signatureapi.com/docs/integrations/power-automate/actions/add-document

Parameters

Name Key Required Type Description
Envelope ID
 envelopeId True string

The ID of the envelope.
Document Title
 title string

The title of this document. This may be shown to recipients.
File Content
 file_content True byte

The content of the document file.
Extra Properties
 extra string

Extra properties for extensibility

Returns

Body
AddDocumentOutput

Add a place — Envelope completed date

Operation ID:
AddPlaceEnvelopeCompletedDate

Adds a envelope completed date place to a document. https://signatureapi.com/docs/integrations/power-automate/actions/add-envelope-completed-date-place

Parameters

Name Key Required Type Description
Document ID
 documentId True string

The ID of the document.
Place Key
 key True string

A key that identifies this place within the document.
Date Format
 date_format string

Defines the format of the date and time. Refer to the documentation for allowed values.
Page Number
 page number

The page number to position this place.
Distance From Top
 top number

The distance (in points) from the top of the page to the bottom of the place.
Distance From Left
 left number

The distance (in points) from the left of the page to the place.
Extra Properties
 extra string

Extra properties for extensibility

Add a place — Initials

Operation ID:
AddPlaceInitials

Adds an initials place to a document. https://signatureapi.com/docs/integrations/power-automate/actions/add-initials-place

Parameters

Name Key Required Type Description
Document ID
 documentId True string

The ID of the document.
Place Key
 key True string

A key that identifies this place within the document.
Recipient Key
 recipient_key True string

The recipient's key this place refers to.
Place Height
 height number

Set a custom height, the width adjusts proportionally.
Page Number
 page number

The page number to position this place.
Distance From Top
 top number

The distance (in points) from the top of the page to the bottom of the place.
Distance From Left
 left number

The distance (in points) from the left of the page to the place.
Extra Properties
 extra string

Extra properties for extensibility

Add a place — Recipient completed date

Operation ID:
AddPlaceRecipientCompletedDate

Adds a recipient completed date place to a document. https://signatureapi.com/docs/integrations/power-automate/actions/add-recipient-completed-date-place

Parameters

Name Key Required Type Description
Document ID
 documentId True string

The ID of the document.
Place Key
 key True string

A key that identifies this place within the document.
Recipient Key
 recipient_key True string

The recipient's key this place refers to.
Date Format
 date_format string

Defines the format of the date and time. Refer to the documentation for allowed values.
Page Number
 page number

The page number to position this place.
Distance From Top
 top number

The distance (in points) from the top of the page to the bottom of the place.
Distance From Left
 left number

The distance (in points) from the left of the page to the place.
Extra Properties
 extra string

Extra properties for extensibility

Add a place — Signature

Operation ID:
AddPlaceSignature

Adds a signature place to a document. https://signatureapi.com/docs/integrations/power-automate/actions/add-signature-place

Parameters

Name Key Required Type Description
Document ID
 documentId True string

The ID of the document.
Place Key
 key True string

A key that identifies this place within the document.
Recipient Key
 recipient_key True string

The recipient's key this place refers to.
Place Height
 height number

Set a custom height, the width adjusts proportionally.
Page Number
 page number

The page number to position this place.
Distance From Top
 top number

The distance (in points) from the top of the page to the bottom of the place.
Distance From Left
 left number

The distance (in points) from the left of the page to the place.
Extra Properties
 extra string

Extra properties for extensibility

Add a place — Text

Operation ID:
AddPlaceText

Adds a text place to a document. https://signatureapi.com/docs/integrations/power-automate/actions/add-text-place

Parameters

Name Key Required Type Description
Document ID
 documentId True string

The ID of the document.
Place Key
 key True string

A key that identifies this place within the document.
Value
 value True string

The value for this text place.
Font Size
 font_size number

The font size in points.
Font Color
 font_color string

The font color in hexadecimal notation.
Page Number
 page number

The page number to position this place.
Distance From Top
 top number

The distance (in points) from the top of the page to the bottom of the place.
Distance From Left
 left number

The distance (in points) from the left of the page to the place.
Extra Properties
 extra string

Extra properties for extensibility

Add a place — Text Input

Operation ID:
AddPlaceTextInput

Adds a text input place to a document. https://signatureapi.com/docs/integrations/power-automate/actions/add-text-input-place

Parameters

Name Key Required Type Description
Document ID
 documentId True string

The ID of the document.
Place Key
 key True string

A key that identifies this place within the document.
Recipient Key
 recipient_key True string

The recipient's key this place refers to.
Capture As
 capture_as string

A key that stores the recipient's input and is included in the envelope captures.
Hint
 hint string

A tooltip message shown over the input field for the recipient.
Prompt
 prompt string

A placeholder message shown inside the input text field during the signing ceremony.
Requirement
 requirement string

Specifies whether the recipient must fill this field to complete the signing ceremony.
Format
 format string

Specifies the valid format for user input. Refer to the documentation for allowed values.
Format Message
 format_message string

The message displayed when the user’s input does not match the required format.
Page Number
 page number

The page number to position this place.
Distance From Top
 top number

The distance (in points) from the top of the page to the bottom of the place.
Distance From Left
 left number

The distance (in points) from the left of the page to the place.
Extra Properties
 extra string

Extra properties for extensibility

Add a recipient — Signer

Operation ID:
AddRecipient

Adds a recipient to an envelope. https://signatureapi.com/docs/integrations/power-automate/actions/add-recipient

Parameters

Name Key Required Type Description
Envelope ID
 envelopeId True string

The ID of the envelope.
Recipient Name
 name True string

The name of the recipient.
Recipient Email
 email True string

The email address of the recipient.
Recipient Key
 key True string

A key that identifies a recipient within an envelope.
Recipient Ceremony Creation
 ceremony_creation string

How the ceremonies for a recipient are created.
Recipient Delivery Type
 delivery_type string

How the deliverable is sent to the recipient.
Extra Properties
 extra string

Extra properties for extensibility

Returns

Body
AddRecipientSignerOutput

Add a template — DOCX

Operation ID:
AddTemplate

Adds a DOCX template to an envelope. https://signatureapi.com/docs/integrations/power-automate/actions/add-template

Parameters

Name Key Required Type Description
Envelope ID
 envelopeId True string

The ID of the envelope.
Document Title
 title string

The title of this document. This may be shown to recipients.
File Content
 file_content True byte

The content of the document file.
Template Data
 data array of string

Field: Value pair containing data to fill into the template.
Extra Properties
 extra string

Extra properties for extensibility

Returns

Body
AddDocumentOutput

Add data to template

Operation ID:
AddTemplateData

Adds data to a template. https://signatureapi.com/docs/integrations/power-automate/actions/add-template-data

Parameters

Name Key Required Type Description
Document ID
 documentId True string

The ID of the document.
Field Name
 field_name True string

The name of the field in the template.
Value
 value True string

The value for the field in the template.

Create a ceremony — Custom authentication

Operation ID:
CreateCeremonyCustom

Creates a ceremony where the recipient is authenticated externally to SignatureAPI. Use this to obtain a ceremony URL for sharing with recipients. Before using custom authentication read https://signatureapi.com/docs/integrations/power-automate/actions/create-ceremony-custom

Parameters

Name Key Required Type Description
Recipient ID
 recipientId True string

The ID of the recipient.
Authentication Provider
 provider True string

The name of the authentication provider. This value is arbitrary and will appear in the audit logs of the envelope.
Authentication Data
 data True array of string

Key: Value pair containing authentication metadata. These details will be included in the envelope's audit logs.
Redirect URL
 redirect_url string

A URL to redirect the recipient to after a ceremony is finished. Learn more in: https://signatureapi.com/docs/resources/ceremonies/redirect-url
Extra Properties
 extra string

Extra properties for extensibility

Returns

Body
CreateCeremonyCustomOutput
Operation ID:
CreateCeremonyEmailLink

Creates a ceremony where the recipient is authenticated via a link sent to their email. https://signatureapi.com/docs/integrations/power-automate/actions/create-ceremony-email-link

Parameters

Name Key Required Type Description
Recipient ID
 recipientId True string

The ID of the recipient.
Redirect URL
 redirect_url string

A URL to redirect the recipient to after a ceremony is finished. Learn more in: https://signatureapi.com/docs/resources/ceremonies/redirect-url
Extra Properties
 extra string

Extra properties for extensibility

Returns

response
object

Create an envelope

Operation ID:
CreateEnvelope

Creates a new envelope to which you can add recipients and documents. When ready, use the 'Start an envelope' action to initiate the signing process. https://signatureapi.com/docs/integrations/power-automate/actions/create-envelope

Parameters

Name Key Required Type Description
Envelope Title
 title True string

The title of this envelope. This may be shown to recipients.
Envelope Label
 label string

Custom label given to the envelope for easier identification. Labels are for internal use and are not shown to recipients.
Envelope Message
 message string

A message that will be sent to the recipients.
Envelope Mode
 mode string

Test mode envelopes are non-binding and not billed.
Envelope Routing
 routing string

The order in which recipients sign the envelope. It can be parallel, where all recipients can sign simultaneously, or sequential, where recipients sign one after another.
Language
 language string

The default language to be used in the signing ceremony and deliverables. If not specified, the account's default language is used. https://signatureapi.com/docs/localization/language
Time Zone
 timezone string

The time zone to be used for timestamps in deliverables. If not specified, the account's default timezone offset is used. https://signatureapi.com/docs/localization/timezone
Timestamp Format
 timestamp_format string

The date and time format to be used in timestamps for deliverables. If not specified, the account's default timestamp format is used. https://signatureapi.com/docs/localization/timestamp_format
Envelope Attestation
 attestation string

Regulatory or compliance attestation
Name
 name string

The name of the sender.
Email
 email string

The email address of the sender.
Envelope Topics
 topics array of string

Use to classify envelopes and filter webhook notifications.
Extra Properties
 extra string

Extra properties for extensibility

Returns

Body
CreateEnvelopeOutput

Delete an envelope

Operation ID:
DeleteEnvelope

Deletes an envelope and all associated information. https://signatureapi.com/docs/integrations/power-automate/actions/delete-envelope

Parameters

Name Key Required Type Description
Envelope ID
 envelopeId True string

The ID of the envelope.

Get a captured value

Operation ID:
GetCapture

Retrieves a value entered by a recipient in an input place during signing. https://signatureapi.com/docs/integrations/power-automate/actions/get-capture

Parameters

Name Key Required Type Description
Envelope ID
 envelopeId True string

The ID of the envelope.
Capture Key
 captureKey True string

The key of the captured value.

Returns

Body
Capture

Get a deliverable

Operation ID:
GetDeliverable

Retrieves a deliverable using its ID. Use it to download a signed copy of the envelope. https://signatureapi.com/docs/integrations/power-automate/actions/get-deliverable

Parameters

Name Key Required Type Description
Deliverable ID
 deliverableId True string

The ID of the deliverable.

Returns

Body
Deliverable

Get a recipient

Operation ID:
GetRecipient

Retrieves recipient details by their ID. https://signatureapi.com/docs/integrations/power-automate/actions/get-recipient

Parameters

Name Key Required Type Description
Recipient ID
 recipientId True string

The ID of the recipient.

Returns

Body
Recipient

Get an envelope

Operation ID:
GetEnvelope

Retrieves envelope details by its ID. https://signatureapi.com/docs/integrations/power-automate/actions/get-envelope

Parameters

Name Key Required Type Description
Envelope ID
 envelopeId True string

The ID of the envelope.

Returns

Body
Envelope

Start an envelope

Operation ID:
StartEnvelope

Initiates the signing process for an envelope. https://signatureapi.com/docs/integrations/power-automate/actions/start-envelope

Parameters

Name Key Required Type Description
Envelope ID
 envelopeId True string

The ID of the envelope.

Returns

Body
StartEnvelopeOutput

Wait for envelope

Operation ID:
WaitEnvelope

Waits for an envelope to reach a completed state or another final status. https://signatureapi.com/docs/integrations/power-automate/actions/wait-envelope

Parameters

Name Key Required Type Description
Envelope ID
 envelopeId True string

The ID of the envelope.

Returns

Body
Envelope

Triggers

When a deliverable fails

This event occurs when the generation of a deliverable fails, resulting in a deliverable status of failed.
When a deliverable is generated

This event occurs when a deliverable, such as an audit log, is successfully generated.
When a recipient bounces

This event occurs when an email is undeliverable, either temporarily (soft-bounce) or permanently (hard-bounce).
When a recipient fails

This event occurs when there is a failure related to a recipient, resulting in a recipient status of failed.
When a recipient is completed

This event occurs when a recipient has completed their part of the signing process.
When a recipient is rejected

This event occurs when a recipient rejects the envelope.
When a recipient is released

This event occurs when a recipient is ready to be sent a request to complete an envelope.
When a recipient is replaced

This event occurs when a recipient is replaced with a new one.
When a recipient is resent

This event occurs when a request is resent to a recipient.
When a recipient is sent

This event occurs when a request is sent to a recipient.
When an envelope fails

This event occurs when an envelope fails, resulting in an envelope status of failed.
When an envelope has started

This event occurs when an envelope status transitions from processing to in_progress, indicating it is ready to be sent to recipients.
When an envelope is canceled

This event occurs when the signing process has been intentionally stopped before completion, resulting in an envelope status of canceled.
When an envelope is completed

This event occurs when an envelope status transitions from in_progress to completed, indicating it has been completed by all recipients.
When an envelope is created

This event occurs whenever an Envelope is created.

When a deliverable fails

Operation ID:
CreateEndpointForDeliverableFailed

This event occurs when the generation of a deliverable fails, resulting in a deliverable status of failed.

Parameters

Name Key Required Type Description
Topics
 topics array of string

Use to classify envelopes and filter webhook notifications.

Returns

Body
NotificationForDeliverableFailed

When a deliverable is generated

Operation ID:
CreateEndpointForDeliverableGenerated

This event occurs when a deliverable, such as an audit log, is successfully generated.

Parameters

Name Key Required Type Description
Topics
 topics array of string

Use to classify envelopes and filter webhook notifications.

Returns

Body
NotificationForDeliverableGenerated

When a recipient bounces

Operation ID:
CreateEndpointForRecipientBounced

This event occurs when an email is undeliverable, either temporarily (soft-bounce) or permanently (hard-bounce).

Parameters

Name Key Required Type Description
Topics
 topics array of string

Use to classify envelopes and filter webhook notifications.

Returns

Body
NotificationForRecipientBounced

When a recipient fails

Operation ID:
CreateEndpointForRecipientFailed

This event occurs when there is a failure related to a recipient, resulting in a recipient status of failed.

Parameters

Name Key Required Type Description
Topics
 topics array of string

Use to classify envelopes and filter webhook notifications.

Returns

Body
NotificationForRecipientFailed

When a recipient is completed

Operation ID:
CreateEndpointForRecipientCompleted

This event occurs when a recipient has completed their part of the signing process.

Parameters

Name Key Required Type Description
Topics
 topics array of string

Use to classify envelopes and filter webhook notifications.

Returns

Body
NotificationForRecipientCompleted

When a recipient is rejected

Operation ID:
CreateEndpointForRecipientRejected

This event occurs when a recipient rejects the envelope.

Parameters

Name Key Required Type Description
Topics
 topics array of string

Use to classify envelopes and filter webhook notifications.

Returns

Body
NotificationForRecipientRejected

When a recipient is released

Operation ID:
CreateEndpointForRecipientReleased

This event occurs when a recipient is ready to be sent a request to complete an envelope.

Parameters

Name Key Required Type Description
Topics
 topics array of string

Use to classify envelopes and filter webhook notifications.

Returns

Body
NotificationForRecipientReleased

When a recipient is replaced

Operation ID:
CreateEndpointForRecipientReplaced

This event occurs when a recipient is replaced with a new one.

Parameters

Name Key Required Type Description
Topics
 topics array of string

Use to classify envelopes and filter webhook notifications.

Returns

Body
NotificationForRecipientReplaced

When a recipient is resent

Operation ID:
CreateEndpointForRecipientResent

This event occurs when a request is resent to a recipient.

Parameters

Name Key Required Type Description
Topics
 topics array of string

Use to classify envelopes and filter webhook notifications.

Returns

Body
NotificationForRecipientResent

When a recipient is sent

Operation ID:
CreateEndpointForRecipientSent

This event occurs when a request is sent to a recipient.

Parameters

Name Key Required Type Description
Topics
 topics array of string

Use to classify envelopes and filter webhook notifications.

Returns

Body
NotificationForRecipientSent

When an envelope fails

Operation ID:
CreateEndpointForEnvelopeFailed

This event occurs when an envelope fails, resulting in an envelope status of failed.

Parameters

Name Key Required Type Description
Topics
 topics array of string

Use to classify envelopes and filter webhook notifications.

Returns

Body
NotificationForEnvelopeFailed

When an envelope has started

Operation ID:
CreateEndpointForEnvelopeStarted

This event occurs when an envelope status transitions from processing to in_progress, indicating it is ready to be sent to recipients.

Parameters

Name Key Required Type Description
Topics
 topics array of string

Use to classify envelopes and filter webhook notifications.

Returns

Body
NotificationForEnvelopeStarted

When an envelope is canceled

Operation ID:
CreateEndpointForEnvelopeCanceled

This event occurs when the signing process has been intentionally stopped before completion, resulting in an envelope status of canceled.

Parameters

Name Key Required Type Description
Topics
 topics array of string

Use to classify envelopes and filter webhook notifications.

Returns

Body
NotificationForEnvelopeCanceled

When an envelope is completed

Operation ID:
CreateEndpointForEnvelopeCompleted

This event occurs when an envelope status transitions from in_progress to completed, indicating it has been completed by all recipients.

Parameters

Name Key Required Type Description
Topics
 topics array of string

Use to classify envelopes and filter webhook notifications.

Returns

Body
NotificationForEnvelopeCompleted

When an envelope is created

Operation ID:
CreateEndpointForEnvelopeCreated

This event occurs whenever an Envelope is created.

Parameters

Name Key Required Type Description
Topics
 topics array of string

Use to classify envelopes and filter webhook notifications.

Returns

Body
NotificationForEnvelopeCreated

Definitions

Envelope

Name Path Type Description
Envelope ID
 id EnvelopeId

The ID of the envelope.
Envelope Title
 title EnvelopeTitle

The title of this envelope. This may be shown to recipients.
Envelope Label
 label EnvelopeLabel

Custom label given to the envelope for easier identification. Labels are for internal use and are not shown to recipients.
Envelope Message
 message EnvelopeMessage

A message that will be sent to the recipients.
sender
 sender EnvelopeSender
Envelope Status
 status EnvelopeStatus

The status of the envelope.
deliverable
 deliverable EnvelopeDeliverable
Envelope Completed At
 completed_at EnvelopeCompletedAt

Time when all the recipients completed the envelope.
Envelope Mode
 mode EnvelopeMode

Test mode envelopes are non-binding and not billed.
Envelope Routing
 routing EnvelopeRouting

The order in which recipients sign the envelope. It can be parallel, where all recipients can sign simultaneously, or sequential, where recipients sign one after another.
Time Zone
 timezone EnvelopeTimezone

The time zone to be used for timestamps in deliverables. If not specified, the account's default timezone offset is used. https://signatureapi.com/docs/localization/timezone
Timestamp Format
 timestamp_format EnvelopeTimestampFormat

The date and time format to be used in timestamps for deliverables. If not specified, the account's default timestamp format is used. https://signatureapi.com/docs/localization/timestamp_format
Envelope Attestation
 attestation EnvelopeAttestation

Regulatory or compliance attestation
Envelope Topics
 topics EnvelopeTopics

Use to classify envelopes and filter webhook notifications.

Recipient

Name Path Type Description
Recipient Id
 id RecipientId

The ID of the recipient.
Envelope ID
 envelope_id EnvelopeId

The ID of the envelope.
Recipient Type
 type RecipientType

The type of the recipient.
Recipient Key
 key RecipientKey

A key that identifies a recipient within an envelope.
Recipient Name
 name RecipientName

The name of the recipient.
Recipient Email
 email RecipientEmail

The email address of the recipient.
Recipient Status
 status RecipientStatus

The status of the recipient.
Recipient Ceremony Creation
 ceremony_creation RecipientCeremonyCreation

How the ceremonies for a recipient are created.
Recipient Delivery Type
 delivery_type RecipientDeliveryType

How the deliverable is sent to the recipient.
Recipient Completed At
 completed_at RecipientCompletedAt

Time when the recipient completed the envelope.

Deliverable

Name Path Type Description
Deliverable Id
 id DeliverableId

The ID of the deliverable.
Deliverable Type
 type DeliverableType

The type of the deliverable.
Deliverable Status
 status DeliverableStatus

The status of the deliverable.
File Content
 file_content DeliverableFileContent

The file content of the deliverable. Use it to save a signed copy of the envelope.

Capture

Name Path Type Description
Capture Value
 value CaptureValue

The value of the recipient input capture

CreateEnvelopeOutput

Name Path Type Description
Envelope ID
 id EnvelopeId

The ID of the envelope.
Envelope Title
 title EnvelopeTitle

The title of this envelope. This may be shown to recipients.
Envelope Label
 label EnvelopeLabel

Custom label given to the envelope for easier identification. Labels are for internal use and are not shown to recipients.
Envelope Message
 message EnvelopeMessage

A message that will be sent to the recipients.
sender
 sender EnvelopeSender
Envelope Mode
 mode EnvelopeMode

Test mode envelopes are non-binding and not billed.
Envelope Routing
 routing EnvelopeRouting

The order in which recipients sign the envelope. It can be parallel, where all recipients can sign simultaneously, or sequential, where recipients sign one after another.
Time Zone
 timezone EnvelopeTimezone

The time zone to be used for timestamps in deliverables. If not specified, the account's default timezone offset is used. https://signatureapi.com/docs/localization/timezone
Timestamp Format
 timestamp_format EnvelopeTimestampFormat

The date and time format to be used in timestamps for deliverables. If not specified, the account's default timestamp format is used. https://signatureapi.com/docs/localization/timestamp_format
Envelope Attestation
 attestation EnvelopeAttestation

Regulatory or compliance attestation
Envelope Topics
 topics EnvelopeTopics

Use to classify envelopes and filter webhook notifications.

StartEnvelopeOutput

Name Path Type Description
Envelope Status
 status EnvelopeStatus

The status of the envelope.

AddDocumentOutput

Name Path Type Description
Document ID
 id DocumentId

The ID of the document

AddRecipientSignerOutput

Name Path Type Description
Recipient Id
 id RecipientId

The ID of the recipient.
Recipient Name
 name RecipientName

The name of the recipient.
Recipient Email
 email RecipientEmail

The email address of the recipient.
Recipient Key
 key RecipientKey

A key that identifies a recipient within an envelope.
Recipient Ceremony Creation
 ceremony_creation RecipientCeremonyCreation

How the ceremonies for a recipient are created.
Recipient Delivery Type
 delivery_type RecipientDeliveryType

How the deliverable is sent to the recipient.

CreateCeremonyCustomOutput

Name Path Type Description
Ceremony URL
 url CeremonyUrl

The URL the recipient must visit to initiate the ceremony

EnvelopeId

The ID of the envelope.

The ID of the envelope.

Envelope ID
string

EnvelopeTitle

The title of this envelope. This may be shown to recipients.

The title of this envelope. This may be shown to recipients.

Envelope Title
string

EnvelopeLabel

Custom label given to the envelope for easier identification. Labels are for internal use and are not shown to recipients.

Custom label given to the envelope for easier identification. Labels are for internal use and are not shown to recipients.

Envelope Label
string

EnvelopeMessage

A message that will be sent to the recipients.

A message that will be sent to the recipients.

Envelope Message
string

EnvelopeRouting

The order in which recipients sign the envelope. It can be parallel, where all recipients can sign simultaneously, or sequential, where recipients sign one after another.

The order in which recipients sign the envelope. It can be parallel, where all recipients can sign simultaneously, or sequential, where recipients sign one after another.

Envelope Routing
string

EnvelopeTimezone

The time zone to be used for timestamps in deliverables. If not specified, the account's default timezone offset is used. https://signatureapi.com/docs/localization/timezone

The time zone to be used for timestamps in deliverables. If not specified, the account's default timezone offset is used. https://signatureapi.com/docs/localization/timezone

Time Zone
string

EnvelopeTimestampFormat

The date and time format to be used in timestamps for deliverables. If not specified, the account's default timestamp format is used. https://signatureapi.com/docs/localization/timestamp_format

The date and time format to be used in timestamps for deliverables. If not specified, the account's default timestamp format is used. https://signatureapi.com/docs/localization/timestamp_format

Timestamp Format
string

EnvelopeSender

Name Path Type Description
Sender Name
 name string

The name of the sender.
Sender Email
 email string

The email address of the sender.

EnvelopeStatus

The status of the envelope.

The status of the envelope.

Envelope Status
string

EnvelopeMode

Test mode envelopes are non-binding and not billed.

Test mode envelopes are non-binding and not billed.

Envelope Mode
string

EnvelopeTopics

Use to classify envelopes and filter webhook notifications.

Name Path Type Description
Items
 string

EnvelopeAttestation

Regulatory or compliance attestation

Regulatory or compliance attestation

Envelope Attestation
string

EnvelopeDeliverable

Name Path Type Description
Deliverable ID
 id string

The ID of the deliverable. Use this to download a signed copy of the envelope.

EnvelopeCompletedAt

Time when all the recipients completed the envelope.

Time when all the recipients completed the envelope.

Envelope Completed At
date-time

DocumentId

The ID of the document

The ID of the document

Document ID
string

RecipientId

The ID of the recipient.

The ID of the recipient.

Recipient Id
string

RecipientType

The type of the recipient.

The type of the recipient.

Recipient Type
string

RecipientName

The name of the recipient.

The name of the recipient.

Recipient Name
string

RecipientEmail

The email address of the recipient.

The email address of the recipient.

Recipient Email
string

RecipientKey

A key that identifies a recipient within an envelope.

A key that identifies a recipient within an envelope.

Recipient Key
string

RecipientStatus

The status of the recipient.

The status of the recipient.

Recipient Status
string

RecipientCeremonyCreation

How the ceremonies for a recipient are created.

How the ceremonies for a recipient are created.

Recipient Ceremony Creation
string

RecipientDeliveryType

How the deliverable is sent to the recipient.

How the deliverable is sent to the recipient.

Recipient Delivery Type
string

RecipientCompletedAt

Time when the recipient completed the envelope.

Time when the recipient completed the envelope.

Recipient Completed At
date-time

DeliverableId

The ID of the deliverable.

The ID of the deliverable.

Deliverable Id
string

DeliverableType

The type of the deliverable.

The type of the deliverable.

Deliverable Type
string

DeliverableStatus

The status of the deliverable.

The status of the deliverable.

Deliverable Status
string

DeliverableFileContent

The file content of the deliverable. Use it to save a signed copy of the envelope.

The file content of the deliverable. Use it to save a signed copy of the envelope.

File Content
byte

CeremonyUrl

The URL the recipient must visit to initiate the ceremony

The URL the recipient must visit to initiate the ceremony

Ceremony URL
string

CaptureValue

The value of the recipient input capture

The value of the recipient input capture

Capture Value
string

NotificationForEnvelopeCreated

Name Path Type Description
Event ID
 id EventId

The ID of the event.
Event Timestamp
 timestamp EventTimestamp

The date and time of the event, in ISO 8601 format.
Event Type
 type EventType

The type of the event.
Envelope ID
 data.envelope_id EventEnvelopeId

The ID of the envelope this event refers to.

NotificationForEnvelopeStarted

Name Path Type Description
Event ID
 id EventId

The ID of the event.
Event Timestamp
 timestamp EventTimestamp

The date and time of the event, in ISO 8601 format.
Event Type
 type EventType

The type of the event.
Envelope ID
 data.envelope_id EventEnvelopeId

The ID of the envelope this event refers to.

NotificationForEnvelopeCompleted

Name Path Type Description
Event ID
 id EventId

The ID of the event.
Event Timestamp
 timestamp EventTimestamp

The date and time of the event, in ISO 8601 format.
Event Type
 type EventType

The type of the event.
Envelope ID
 data.envelope_id EventEnvelopeId

The ID of the envelope this event refers to.

NotificationForEnvelopeFailed

Name Path Type Description
Event ID
 id EventId

The ID of the event.
Event Timestamp
 timestamp EventTimestamp

The date and time of the event, in ISO 8601 format.
Event Type
 type EventType

The type of the event.
Envelope ID
 data.envelope_id EventEnvelopeId

The ID of the envelope this event refers to.
Detail
 data.detail string

Information about the failure.

NotificationForEnvelopeCanceled

Name Path Type Description
Event ID
 id EventId

The ID of the event.
Event Timestamp
 timestamp EventTimestamp

The date and time of the event, in ISO 8601 format.
Event Type
 type EventType

The type of the event.
Envelope ID
 data.envelope_id EventEnvelopeId

The ID of the envelope this event refers to.

NotificationForRecipientReleased

Name Path Type Description
Event ID
 id EventId

The ID of the event.
Event Timestamp
 timestamp EventTimestamp

The date and time of the event, in ISO 8601 format.
Event Type
 type EventType

The type of the event.
Envelope ID
 data.envelope_id EventEnvelopeId

The ID of the envelope this event refers to.
Recipient ID
 data.object_id EventRecipientId

The ID of the recipient this event refers to.
Recipient Type
 data.recipient_type EventRecipientType

The type of recipient this event refers to.
Recipient Key
 data.recipient_key EventRecipientKey

The key of recipient this event refers to.

NotificationForRecipientSent

Name Path Type Description
Event ID
 id EventId

The ID of the event.
Event Timestamp
 timestamp EventTimestamp

The date and time of the event, in ISO 8601 format.
Event Type
 type EventType

The type of the event.
Envelope ID
 data.envelope_id EventEnvelopeId

The ID of the envelope this event refers to.
Recipient ID
 data.object_id EventRecipientId

The ID of the recipient this event refers to.
Recipient Type
 data.recipient_type EventRecipientType

The type of recipient this event refers to.
Recipient Key
 data.recipient_key EventRecipientKey

The key of recipient this event refers to.

NotificationForRecipientCompleted

Name Path Type Description
Event ID
 id EventId

The ID of the event.
Event Timestamp
 timestamp EventTimestamp

The date and time of the event, in ISO 8601 format.
Event Type
 type EventType

The type of the event.
Envelope ID
 data.envelope_id EventEnvelopeId

The ID of the envelope this event refers to.
Recipient ID
 data.object_id EventRecipientId

The ID of the recipient this event refers to.
Recipient Type
 data.recipient_type EventRecipientType

The type of recipient this event refers to.
Recipient Key
 data.recipient_key EventRecipientKey

The key of recipient this event refers to.

NotificationForRecipientRejected

Name Path Type Description
Event ID
 id EventId

The ID of the event.
Event Timestamp
 timestamp EventTimestamp

The date and time of the event, in ISO 8601 format.
Event Type
 type EventType

The type of the event.
Envelope ID
 data.envelope_id EventEnvelopeId

The ID of the envelope this event refers to.
Recipient ID
 data.object_id EventRecipientId

The ID of the recipient this event refers to.
Recipient Type
 data.recipient_type EventRecipientType

The type of recipient this event refers to.
Recipient Key
 data.recipient_key EventRecipientKey

The key of recipient this event refers to.
Reason
 data.reason string

The recipient's explanation for the rejection.

NotificationForRecipientBounced

Name Path Type Description
Event ID
 id EventId

The ID of the event.
Event Timestamp
 timestamp EventTimestamp

The date and time of the event, in ISO 8601 format.
Event Type
 type EventType

The type of the event.
Envelope ID
 data.envelope_id EventEnvelopeId

The ID of the envelope this event refers to.
Recipient ID
 data.object_id EventRecipientId

The ID of the recipient this event refers to.
Recipient Type
 data.recipient_type EventRecipientType

The type of recipient this event refers to.
Recipient Key
 data.recipient_key EventRecipientKey

The key of recipient this event refers to.
Detail
 data.detail string

Information about the bounce.

NotificationForRecipientFailed

Name Path Type Description
Event ID
 id EventId

The ID of the event.
Event Timestamp
 timestamp EventTimestamp

The date and time of the event, in ISO 8601 format.
Event Type
 type EventType

The type of the event.
Envelope ID
 data.envelope_id EventEnvelopeId

The ID of the envelope this event refers to.
Recipient ID
 data.object_id EventRecipientId

The ID of the recipient this event refers to.
Recipient Type
 data.recipient_type EventRecipientType

The type of recipient this event refers to.
Recipient Key
 data.recipient_key EventRecipientKey

The key of recipient this event refers to.
Detail
 data.detail string

Information about the failure.

NotificationForRecipientReplaced

Name Path Type Description
Event ID
 id EventId

The ID of the event.
Event Timestamp
 timestamp EventTimestamp

The date and time of the event, in ISO 8601 format.
Event Type
 type EventType

The type of the event.
Envelope ID
 data.envelope_id EventEnvelopeId

The ID of the envelope this event refers to.
Recipient ID
 data.object_id EventRecipientId

The ID of the recipient this event refers to.
Recipient Type
 data.recipient_type EventRecipientType

The type of recipient this event refers to.
Recipient Key
 data.recipient_key EventRecipientKey

The key of recipient this event refers to.
New Recipient ID
 data.new_recipient_id string

The ID of the new recipient.

NotificationForRecipientResent

Name Path Type Description
Event ID
 id EventId

The ID of the event.
Event Timestamp
 timestamp EventTimestamp

The date and time of the event, in ISO 8601 format.
Event Type
 type EventType

The type of the event.
Envelope ID
 data.envelope_id EventEnvelopeId

The ID of the envelope this event refers to.
Recipient ID
 data.object_id EventRecipientId

The ID of the recipient this event refers to.
Recipient Type
 data.recipient_type EventRecipientType

The type of recipient this event refers to.
Recipient Key
 data.recipient_key EventRecipientKey

The key of recipient this event refers to.

NotificationForDeliverableGenerated

Name Path Type Description
Event ID
 id EventId

The ID of the event.
Event Timestamp
 timestamp EventTimestamp

The date and time of the event, in ISO 8601 format.
Event Type
 type EventType

The type of the event.
Envelope ID
 data.envelope_id EventEnvelopeId

The ID of the envelope this event refers to.
Deliverable ID
 data.object_id EventDeliverableId

The ID of the deliverable this event refers to.

NotificationForDeliverableFailed

Name Path Type Description
Event ID
 id EventId

The ID of the event.
Event Timestamp
 timestamp EventTimestamp

The date and time of the event, in ISO 8601 format.
Event Type
 type EventType

The type of the event.
Envelope ID
 data.envelope_id EventEnvelopeId

The ID of the envelope this event refers to.
Deliverable ID
 data.object_id EventDeliverableId

The ID of the deliverable this event refers to.
Detail
 data.detail string

Information about the failure.

EventId

The ID of the event.

The ID of the event.

Event ID
string

EventTimestamp

The date and time of the event, in ISO 8601 format.

The date and time of the event, in ISO 8601 format.

Event Timestamp
date-time

EventType

The type of the event.

The type of the event.

Event Type
string

EventEnvelopeId

The ID of the envelope this event refers to.

The ID of the envelope this event refers to.

Envelope ID
string

EventRecipientId

The ID of the recipient this event refers to.

The ID of the recipient this event refers to.

Recipient ID
string

EventRecipientType

The type of recipient this event refers to.

The type of recipient this event refers to.

Recipient Type
string

EventRecipientKey

The key of recipient this event refers to.

The key of recipient this event refers to.

Recipient Key
string

EventDeliverableId

The ID of the deliverable this event refers to.

The ID of the deliverable this event refers to.

Deliverable ID
string

object

This is the type 'object'.