After a ceremony is finished, whether successful or not, we can redirect to the redirect_url defined in the Ceremony.

The following query parameters are appended to the URL:

Parameter NameDescription
envelope_idThe ID of the envelope.
recipient_idThe ID of the recipient.
ceremony_resultThe result of the ceremony: ceremony.completed, ceremony.declined, or ceremony.failed.

For example, if the redirect_url is set to https://www.example.com, after a successful ceremony it will redirect to:

https://www.example.com/?ceremony_result=ceremony.completed&envelope_id=5b7be28c-6c7c-4aaa-b25f-66879e8d0957&recipient_id=re_0sgQC0cejYRC8wRsT5N9ll

You can use these query parameters to process the ceremony result in your application.

The redirect URL is not available for embedded ceremonies. For those, use Ceremony Events instead.