Overview
Magic Links are a streamlined way to connect your customers to integrations using a customizable URL. This eliminates the need to embed hotglue’s widget, manage JWTs, or implement custom authentication workflows. Magic Links allow you to:- Generate secure, shareable URLs for integration setup
- Customize the appearance to match your brand
- Control which flows and connectors users can access
- Track and manage user connections
Quick Start Guide
1. Brand your magic link
- Go to Settings > Widget
- Select your brand color and fonts
- Go to Settings > Magic Link
- Add your logo, with a title and description for your page.
- Add custom helper buttons
2. Add a custom domain (Pro Plan)
If you don’t see Custom Domain settings, ask the hotglue team to enable it!
-
Choose Domain:
- Go to Settings > Magic Link.
- Enter the full subdomain to deploy the magic link to (e.g.,
links.example.com
).
-
Verify Ownership:
- Add the provided CNAME record via your DNS provider.
- Make sure you turn off proxying for the CNAME, if it’s on by default.
-
Route Traffic:
- Once the first CNAME is detected, you will get a second CNAME record.
- Add the second record to route traffic through our secure servers.
3. Generate a Magic Link via your dashboard
- Go to Tenants > Create Magic Link
- Enter tenant ID (required)
- To limit tenants to particular flows or connectors, select flows and connectors to display (optional)
- Click a “Generate Link”
- Send it to a customer! 🚀
4. Generate a Magic Link via API
To try out your own requests, check out the API reference for Magic links.
POST {env_id}/connect
with your Personal Access Token or Secret API Key, along with atenant
ID.
Basic Magic Link
- Optionally, restrict your tenant to a specific flow…
Flow-locked magic link
Connector-locked magic link
- Any of the above requests will return a
url
that you can share with customers.
Response
5. Advanced settings
When generating a Magic Link, you can pass additionaloptions
to customize the integration experience. You can use any options
control that’s available to the React widget:
Commonly used Options
checkLink
- Never show the configuration popup to your user. Just let the authorize.schemas
- Enable custom field mappingtenantMetadata
- Add additional metadata about your customers, like company nameslistener
- Take action when users connectlocalization
- Custom text and language settingsmultipleSources/multipleConnectors
- Allow users to connect multiple integrationshideBackButtons
- Remove back navigation buttonsnextStep
- Define next step in flow
Example Usage
The below Magic Link generation request would create a link that:- Displays a mapping module to the user
- Redirects the user to the mapping module after they link
Tips
- Decide on a good convention for tenant IDs—it will be harder to change later! Org IDs that you use in other parts of your product will work well.
- Use the customizable buttons to link to documentation and your support.