Quickstart

Get your Plaros embed up and running in under 5 minutes with this step-by-step guide.

Step 1: Get Your Tenant Slug

Your tenant slug is the unique identifier for your organization in Plaros.

1. Log into your Plaros Dashboard (public access coming soon)

2. Navigate to Account Settings

3. Copy your tenant slug (e.g., acme-corp)

Step 2: Generate Your Embed Code

1. In your dashboard, go to Deployments → Embed Configuration

2. Click the Generate Embed Code tab

3. Configure your basic settings:

   • Content Type: Select "Interactive Playbooks"

   • Zone: Choose the zone containing your playbooks

   • Playbook Selection: Leave as "Random Playbook" (recommended)

   • Size: Choose your preferred embed dimensions

Step 3: Copy and Paste

Copy the generated HTML code and paste it into your webpage:

<!-- Responsive Playbook Embed -->
<div class="playbook-embed-container" style="
  position: relative;
  width: 100%;
  max-width: 360px;
  margin: 0 auto;
">
  <div class="playbook-embed-wrapper" style="
    position: relative;
    padding-bottom: 177.78%;
    height: 0;
    overflow: hidden;
  ">
    <iframe
      src="https://play.plaros.com/v1/embed/your-tenant/playbooks?zonePath=your-zone"
      style="
        position: absolute;
        top: 0;
        left: 0;
        width: 100%;
        height: 100%;
        border: 0;
        border-radius: 8px;
      "
      allow="fullscreen"
      title="Interactive Playbook">
    </iframe>
  </div>
</div>

<style>
  @media (max-width: 600px) {
    .playbook-embed-container {
      max-width: 100% !important;
      padding: 0 16px;
    }
    .playbook-embed-wrapper {
      padding-bottom: 177.78% !important;
    }
  }
</style>

Step 4: Test Your Embed

1. Save your HTML file and open it in a browser

2. You should see your interactive playbook loading

3. Test on different screen sizes to verify responsiveness

Understanding the URL Structure

Your embed URL follows this pattern:

https://play.plaros.com/v1/embed/{tenantSlug}/playbooks?zonePath={zonePath}

• {tenantSlug}: Your unique organization identifier

• {zonePath}: The path of the zone containing your playbooks

What's Next?

Now that you have a basic embed working:

• Explore Configuration Options to customize your embed

• Learn about Custom Theming to match your brand

• Check out Integration Examples for your specific framework

• Read our Troubleshooting Guide for common issues

Preview Your Embed

Use the Preview Embed button in your dashboard to test your embed in a popup window before implementing it on your site.

Need Help?

If you run into any issues:

• Check our Troubleshooting section

• Ask questions in our Discord community

• Email us at [email protected]

Congratulations! You've successfully embedded your first Plaros playbook. 🎉