Requirements
To use the embed URL builder, you need:- Organization Admin permissions
- The Embed feature enabled in your Omni instance
- An embed secret generated in Settings > Embed > Admin
Using the URL builder
To generate an embed URL using the URL builder:- Navigate to Settings > Embed > URL Builder in your Omni instance.
- Fill in the required fields:
- Optionally, fill in any additional URL parameters based on your embedding needs.
- Click Generate URL to create your signed embed URL.
- Use the generated URL to test your embed configuration.
Wildcard vanity domains
If your organization has configured a wildcard vanity domain (e.g.,*.omni.example.com), the URL builder will display a Host field. This field is required when using wildcard domains:
- Enter a specific hostname that matches your wildcard pattern (e.g.,
tenant1.omni.example.com). - The hostname will be validated against your configured wildcard domain pattern.
- Invalid hostnames that don’t match the pattern will be rejected with an error message.
The Host field only appears when you have a wildcard vanity domain configured. For standard vanity domains, the host is already specified in your domain configuration.
Next steps
- Learn about all available URL parameters
- Set up custom vanity domains for your embeds
- Explore embed guides for specific implementation scenarios