Handle LAUNCH callbacks

You can fully customize the final page of the LAUNCH flow with HTML and Javascript. To customize the appearance in the Cyclr console, go to Settings > Customize Appearance > Launch Complete HTML.

Example Launch Complete HTML

Plain HTML message

You can display your own message:

HTML

<h1>Congrats - you're connected!</h1>

JavaScript `postMessage`

If you use a popup window, you can display a message with a close button. When your user selects the close button, a JavaScript postMessage sends the result object and closes the popup window.

HTML

    <h1>Congrats - you're connected!</h1>
    <button onclick="closeWindow();">OK</button>
    <script type="text/javascript"> 
        function closeWindow() {
            window.opener.postMessage(JSON.stringify(result), '\*');
            window.close(); 
        }
    </script>

JavaScript result object

A JavaScript result object is available to the window on the final page of the LAUNCH flow. You can use the result object for more processes, such as to update newly installed cycles to complete their setup.

Property	Description
`accountId`	The ID of your end user’s account
`accountApiId`	The API ID of your end user’s account
`cycleId`	The ID of the newly installed integration within your end user’s account
`status`	A string indicating the status of the newly installed integration. By design, will always be Active, unless an issue arose during installation, in which case it will be stopped.
`userId`	The ID of your end user
`webhooks`	An array of URLs representing the endpoints of the webhooks included within the newly installed integration template. This is important where your application needs to send data to Cyclr to trigger the newly installed integration template. Where the newly installed integration template makes use of more than one webhook, the order of the URLs in this array matches the order of the webhook steps in the template.
`errors`	An array of error messages when Cyclr activates the newly installed integration template.
`completeParameter`	The value of the CompleteParameter provided in the LAUNCH API call.
`templateId`	The identifier of the template that the integration is installed from.
`templateReleaseId`	The identifier of the template that the integration is installed from.
`templateTags`	The tags from the template the integration is installed from.

Cross domain issue in Internet Explorer

Internet Explorer doesn’t allow you to use window.opener.postMessage() from a page that’s on a different domain to the opener. You can avoid this problem in two ways.

Proxy iFrame

You can create a popup to a page on your domain with the LAUNCH URL embedded as an iFrame. If you embed the URL, your JavaScript posts to window.parent.postMessage(), which is supported across domains. The proxy page then passes the data back to your application either directly on the backend or with window.opener.postMessage().

Redirect after LAUNCH Complete page

You can use JavaScript in the LAUNCH complete page to redirect your user to a page on your domain, and pass the data from the LAUNCH flow. The new page handles the details on your backend before it closes the popup.