Overview
Ceremony Customization
Customize embedded signing appearance and behavior with URL query parameters
In addition to the customization options available when you create a ceremony, you can further customize the appearance and behavior of an embedded ceremony.
To do this, pass customization options as query parameters in the ceremony URL.
Appearance
Accent Color
You can set the accent color of the ceremony using the accent_color query parameter. The accent color appears in interface elements such as buttons and signature places. Make sure the color you choose is visible against a white document background.
The value must be a valid hexadecimal color code, without the # prefix. The default accent color is a shade of blue.
For example, to set the accent color to purple:
https://sign.signatureapi.com/en/start?token=eyJhbGci…iDsInR&accent_color=8e24aa
The ceremony will look like this:
Behavior
Disable Cancel
As a default, the ceremony allows the signer to cancel the ceremony. You can disable this by setting the allow_cancel query parameter to false. You can do this to handle the cancellation in your application.
This option applies only to embedded ceremonies, which use embedded=true.
https://sign.signatureapi.com/en/start?token=eyJhbGci…iDsInR&allow_cancel=false
Disable Decline
As a default, a standalone ceremony lets the signer decline it. You can remove the Decline control by setting the allow_decline query parameter to false.
This option applies only to standalone ceremonies, which don’t use embedded=true. Embedded signers see Cancel instead of Decline. Use allow_cancel=false to remove it.
https://sign.signatureapi.com/en/start?token=eyJhbGci…iDsInR&allow_decline=false
Event Delivery
The ceremony can send events to your application. Set the event_delivery query parameter to none, message, or redirect. The ceremony sends events only when the URL includes embedded=true.
When you don’t set event_delivery, it defaults to none: the ceremony sends no events and you use webhooks to follow the outcome.
Javascript Messages
When you set event_delivery=message, the ceremony will send events to your application as a Javascript Message with a payload. This is useful when embedding in a web app using <iframe>.
https://sign.signatureapi.com/en/start?token=eyJhbGci…iDsInR&embedded=true&event_delivery=message
Redirects
When you set event_delivery=redirect, the ceremony navigates the WebView to a signatureapi-message:// URL that contains the event. This is useful when embedding in a desktop or mobile app using WebView or similar.
https://sign.signatureapi.com/en/start?token=eyJhbGci…iDsInR&embedded=true&event_delivery=redirect
Result page delay
The redirect_delay property of the ceremony sets how many seconds the result page shows before the completed or declined event. Set it when you create the ceremony, not in the URL. Use 0 to receive the event immediately and show your own result screen. See Ceremony object.
Learn more about delivering events to your application in Ceremony Events.