Skip to main content

​
Overview

The Modal SDK powers the Embedded iPaaS modal in your application. It handles user authorization, renders the modal UI, and exposes methods to install, edit, update, and manage workflows and integrations for your end users.

​
What is the Modal?

The modal is an in-app UI overlay provided by Alloy Automation’s Embedded iPaaS. It lets users install and configure integrations, connect accounts with OAuth, review required scopes, and manage workflows without leaving your product. The Modal SDK authenticates the session with a short-lived user token, renders the UI, and returns results to your app for auditing and follow-up actions. Embedded iPaaS Modal by Alloy Automation

​
When to use

Use the Modal SDK if you present the Embedded iPaaS modal inside your product. It is not required for Headless or Alloy Link flows. What it provides
  • Render the Embedded iPaaS modal for integrations and workflows
  • Authenticate the end user with Alloy.setToken(...)
  • Install, edit, and update workflows: Alloy.install, Alloy.edit, Alloy.update
  • Query installed integrations and workflows: Alloy.getIntegrations, Alloy.getWorkflows
  • Activate or deactivate workflows: Alloy.reactivate, Alloy.deactivate

​
Installing the Modal SDK

Install via npm or yarn: 
npm install alloy-frontend
# or
yarn add alloy-frontend
Or include via script tag: 
<script src="https://cdn.runalloy.com/scripts/embedded.js" type="text/javascript"></script>
Set your user token before calling SDK methods: 
Alloy.setToken("<YOUR_TOKEN>");
Once the token is set, you can render the modal for a specific integration or set of workflows.
⌘I