skills.rest
Hawkfry-Group
Hawkfry-GroupOFFICIAL
Explore all skills by this author →
GitHub

omni-embed-docs

Direct users to official Omni embed docs and SDK sources.

3|Updated May 25, 2025
Search Tags:#documentation#sdk#sso#cross-check#embed#url-parameters#omni
One-click install
npx skills add https://github.com/Hawkfry-Group/omni-embed-demo --skill omni-embed-docs
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: omni-embed-docs
Source: https://github.com/Hawkfry-Group/omni-embed-demo/tree/main/.codex/skills/omni-embed-docs
Command: npx skills add https://github.com/Hawkfry-Group/omni-embed-demo --skill omni-embed-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This skill helps users obtain accurate, source-backed guidance for Omni embedding tasks, including signed SSO URLs, the @omni-co/embed SDK usage, embed URL parameters, events, themes, vanity domains, and session modes, by directing to official documentation and the demo's implementation.

Core Features & Use Cases

  • Official docs first: guide users to docs.omni.co/embed and the npm package page for the embed SDK.
  • Repo cross-check: verify behavior against the demo implementation in src/lib/omni-embed.ts, src/pages/api/embed-url.ts, and client components.
  • Source-backed answers: cite official sources and show source links, while noting repo-specific details as inferences from local code.

Quick Start

Open the official docs at docs.omni.co/embed and review the npm package page for the SDK, then compare with the demo repo to craft an answer including source links.

Frequently Asked Questions about omni-embed-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate a signed SSO URL for embedding Omni?▼

To create a signed SSO URL for Omni embedding, consult the official docs at docs.omni.co/embed and cross-check the demo's server-side implementation in src/pages/api/embed-url.ts to verify the correct signing logic and session parameters.

What is the @omni-co/embed SDK and how do I use it?▼

The @omni-co/embed SDK is the official package for integrating Omni content. Review the npm package page alongside docs.omni.co/embed to understand initialization, and verify client-side usage patterns against the demo's src/lib/omni-embed.ts implementation.

Can I customize themes and vanity domains when embedding Omni dashboards?▼

Yes, Omni embedding supports themes and vanity domains. Check the official documentation for available URL parameters and configuration options, then validate the expected behavior by examining the demo repository's embed implementation and client components.

What are the best practices for handling Omni embed events and session modes?▼

Omni embed best practices for events and session modes are documented at docs.omni.co/embed. Compare these official guidelines with the demo code paths in src/lib/omni-embed.ts to ensure your integration handles session states and event listeners correctly.

Does the Omni embed SDK support custom URL parameters for filtering data?▼

Yes, Omni embedding allows URL parameters for data filtering and configuration. The official documentation details available parameters, and you can cross-reference the demo's src/pages/api/embed-url.ts file to see how parameters are constructed and passed to the embed URL.

Related Skills

Explore More Software Engineering Skills→
exploreomniexploreomni
30

omni-embed

Embed Omni dashboards with signed URLs and postMessage event handling.

Official
Advanced
cyyehcyyeh
1

interactive-dashboard-builder

Build self-contained HTML dashboards with Chart.js and client-side filters.

Community
Intermediate
ggombeeggombee
13

react-nextjs-app

Implement a convention-based file structure for Next.js applications.

Community
Intermediate
minyeamerminyeamer
3

airflow-plugins

Build Airflow 3.1+ plugins embedding FastAPI endpoints and custom UI components.

Community
Advanced