Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.omni.co/llms.txt

Use this file to discover all available pages before exploring further.

The embed URL builder is a tool within Omni that helps you generate and test embed URLs. While primarily designed for internal embedding scenarios (such as embedding Omni in Notion), you can also use it to validate the format of your URL parameters.

​
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:
  1. Navigate to Settings > Embed > URL Builder in your Omni instance.
  2. Fill in the required fields:
  3. Optionally, fill in any additional URL parameters based on your embedding needs.
  4. Click Generate URL to create your signed embed URL.
  5. 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:
  1. Enter a specific hostname that matches your wildcard pattern (e.g., tenant1.omni.example.com).
  2. The hostname will be validated against your configured wildcard domain pattern.
  3. 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