Configuration
Configure your embed settings, permissions, and customization options
Configure your embed to match your app's needs and branding. All settings are managed from your workspace embed page.
Getting Started
- Navigate to your workspace settings
- Go to the Embed section
- Toggle Enable Embed to activate
- Configure your settings and click Save
Basic Settings
Enable Embed
Turn on embed functionality to get your unique embed code. When disabled, existing embeds will stop working.
Show Studio Templates
Allow users to access templates from your workspace. Disable if you want users to start from scratch only.
Allow Template Operations
Control what users can do with templates:
- Delete Templates: Let users remove templates they created
- Rename Templates: Allow changing template names
- Multipage Designs: Enable carousel/slideshow templates
Language Settings
Default Language
Set the interface language for your embed. Choose from available languages including English, Spanish, French, and more.
Allow Language Change
Let users switch languages themselves, or lock it to your default choice.
Branding & Customization
Embed Title
Replace the default workspace name with your brand name in the embed interface.
Custom Icon
Upload your logo (square format, minimum 128x128px) to replace the default Orshot icon.
Accent Color
Choose a color that matches your brand. This affects buttons, highlights, and interactive elements throughout the embed.
Security & Domains
Allowed Domains
Protect your embed by specifying which domains can use it:
Only these domains will be able to load your embed. Leave empty to allow any domain (not recommended for production).
Webhooks
Webhook URL
Get notified when users create or update templates:
Your endpoint will receive POST requests with template data whenever users:
- Create new templates (
template.create
) - Update existing templates (
template.update
)
Example Webhook Handler
Embed Codes
Once configured, you'll get embed codes for different use cases:
Default Embed
Opens with an empty workspace:
Template-Specific Embed
Opens with a specific template loaded:
Testing Your Configuration
Use the live preview to test your settings before going live. The preview shows exactly how users will see your embed with current settings applied.
Permissions Summary
Setting | Description | Default |
---|---|---|
Show Studio Templates | Access workspace templates | Enabled |
Allow Template Delete | Users can delete templates | Enabled |
Allow Template Rename | Users can rename templates | Enabled |
Allow Multipage | Create carousel templates | Enabled |
Allow Language Change | Switch interface language | Disabled |
Best Practices
- Test First: Always test your embed in a staging environment
- Secure Domains: Always specify allowed domains for production
- Brand Consistently: Use your brand colors and logo for seamless integration
- Monitor Webhooks: Set up proper error handling for webhook endpoints
- Update Regularly: Keep your embed settings updated as your app evolves