Embed messaging

Overview

When embedding the package editor or package signing, the embedded frame will send messages to the parent window that can be used to control your workflow and help with debugging during your integration.

Handling embed messages

To handle messages sent from the embedded frame, you need to listen for the message event on the window object. The event object contains information about the message, including the action being performed.

window.addEventListener("message", (event) => {
    // Validate origin
    if (event.origin !== "https://sign.syngrafii.com" || !event.data) return;

    // Handle action
    switch (event.data.action) {
        case "package_close":
            // User has closed the package editor. You should continue with your workflow.
            break;
        case "package_send":
            // User has sent the package and closed the package editor. You should continue with your workflow.
            break;
        case "session_expired":
            // User session has expired. The package editor will show an Expired Session message
            break;
    }
}, false);

You should always validate the origin of the message before processing it to ensure it comes from a trusted source.

Embed message

string

The source of the message, which can be used to customize your workflow.

Source	Description
syngrafii-app	Message was sent from the `Package Editor` or `Video Signing Room` app.
syngrafii-sign-app	Message was sent from the `Sign` app. The `Sign` app is also embedded in the `Video Signing Room` app, so you can receive messages from both sources.
syngrafii-embed	This source is used to send `embed_position` messages to `Video Signing Room` embedded signings.

string

The action being performed.

Action	Description
package_add	User has added a new package.
package_cancel	User has cancelled any changes to the package. They are still in the package editor.
package_close	User has closed the package editor. You should continue with your workflow.
package_open	The package has been opened by the package editor.
package_save	User has saved any changes to the package. They are still in the package editor.
package_send	User has sent the package and closed the package editor. You should continue with your workflow.
meeting_end	Host has ended VSR meeting session.
meeting_joining	User is joining VSR meeting session.
meeting_join	User has joined VSR meeting session.
meeting_start	Host has started VSR meeting session.
signing_changed	User has modified signing; you can use this to track dirty state of signing and prevent navigation.
signing_close	User has closed signing and was redirected to /notsent page.
signing_finalize	User has finalized current document.
signing_ignore	User has ignored save changes warning dialog.
signing_next	User has opened next document for signing.
signing_open	User has opened document for signing.
signing_return	User has completed or closed signing and was redirected back to packages list.
signing_return_url	User has completed or closed signing and was redirected back to returnUrl.
signing_save	User has saved signing progress; you can use this to track dirty state of signing and allow navigation.
signing_sent	User has completed signing all documents and was redirected to /sent page.
session_expired	User session has expired. The package editor will show an Expired Session message.
session_expiring	User session is about to expire due to inactivity. They will be presented with a dialog to extend their session.
session_extended	User session was extended by user.

object

Additional data related to the action being performed. The structure of this object may vary depending on the action.

boolean

Indicates whether the action failed.

string

The error code if the action failed. This field is only present when failed is true.See the Errors guide for more information.

Getting started

Guides

API

Webhooks

Reference

Overview

Handling embed messages

Embed message

​Overview

​Handling embed messages

​Embed message

Overview

Handling embed messages

Embed message