Event | Description |
---|---|
ceremony.completed | The recipient has completed (for example signed) the envelope |
ceremony.canceled | The recipient has canceled the ceremony, for example by clicking the X icon |
ceremony.failed | An error happened and the ceremony can’t be completed |
ceremony.failed
events, the event includes an error_type
and an error_message
that explains the error:
Error Type | Error Message |
---|---|
already_completed | The ceremony has already been completed. |
not_available | The ceremony is no longer available. |
unauthorized | The ceremony URL is invalid |
Delivery type | When to use |
---|---|
Javascript messages | Use this when embedding in web apps using <iframe> |
Deeplink redirects | Use this when embedding in desktop or mobile apps using WebView or similar. |
ceremony.completed
event is:
ceremony.failed
event:
signatureapi-message://
. Your app should detect and intercept the visits to URLs with this structure.
The event type is included as the host part of the URL, and any other data is included as query parameters, URL-encoded. For example the URL for a ceremony.completed
event is:
ceremony.failed
event: