# Configuration
Source: https://docs.logictwelve.com/apiary-confluence/configuration

Configure Apiary Embed for Confluence

There's no site-wide settings screen. Each macro is configured individually, the first time you insert it on a page and any time afterward you choose to edit it.

## Apiary Embed (raw code) macro

Renders an Apiary API Project from the exact embed script Apiary generates for it.

| Field          | Required | Notes                                                                                                                                                                                            |
| -------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **Height**     | Yes      | Fixed iframe height for the embed, e.g. `1048px`. Default: `1048px`                                                                                                                              |
| **Embed code** | Yes      | The full snippet from Apiary's embed generator, pasted as-is — for example `var embed = new Apiary.Embed({"subdomain": "pollsapi"});`. Not validated — invalid code fails silently in the viewer |

<Frame>
  <img alt="Apiary Embed (raw code) macro configuration form" />
</Frame>

## Apiary Embed (generate code) macro

Builds the embed for you from a subdomain and a set of display toggles, instead of requiring the raw script.

| Field                                      | Required | Notes                                                                          |
| ------------------------------------------ | -------- | ------------------------------------------------------------------------------ |
| **Height**                                 | Yes      | Fixed iframe height for the embed. Default: `1048px`                           |
| **Subdomain**                              | Yes      | The API Project's subdomain, set in the Apiary project's settings              |
| **Show Console** (Basics)                  | No       | Default: on. Shows the request console in the machine column                   |
| **Display HTTP Methods** (Basics)          | No       | Default: off. Shows HTTP method names in the human column's action buttons     |
| **Collapse the Machine Column** (Advanced) | No       | Default: off. Hides the machine column by default when the documentation opens |
| **Display URI Parameters** (Advanced)      | No       | Default: off. Shows URI parameters in the human column                         |

<Frame>
  <img alt="Apiary Embed (generate code) macro configuration form" />
</Frame>

## Permissions

Anyone with edit access to a Confluence page can insert either macro and change its configuration. Page viewers without edit access only see the rendered output.


# FAQ
Source: https://docs.logictwelve.com/apiary-confluence/faq

Frequently asked questions about Apiary Embed for Confluence

<AccordionGroup>
  <Accordion title="Does this work with Confluence Data Center, or Cloud only?">
    Cloud only. The app is built on Atlassian's Forge platform, which doesn't support Data Center.
  </Accordion>

  <Accordion title="Which macro should I use, raw code or generate code?">
    Use **Apiary Embed (generate code)** for the common case — provide a subdomain and toggle options in a form. Use **Apiary Embed (raw code)** if you need an option the generate form doesn't expose, or you already have the embed script from Apiary.
  </Accordion>

  <Accordion title="Does the macro update automatically when the Apiary project changes?">
    Yes. Both macros render the API Project live, in an iframe served by Apiary, every time someone views the page — there's no separate republish step.
  </Accordion>

  <Accordion title="The macro shows a warning instead of rendering — what should I check first?">
    There are two distinct warnings. A **license warning** means the site doesn't have an active license or trial. A **"You need to configure this macro"** warning means the required fields aren't filled in yet — check that **Embed code** (raw code macro) or **Subdomain** (generate code macro) is set.
  </Accordion>
</AccordionGroup>

<Tip>
  Can't find what you're looking for? Visit the [Apiary Embed for Confluence service desk portal](https://logictwelve.atlassian.net/servicedesk/customer/portal/3).
</Tip>


# Help Center
Source: https://docs.logictwelve.com/apiary-confluence/help-center





# Installation
Source: https://docs.logictwelve.com/apiary-confluence/installation

Install Apiary Embed for Confluence

Install Apiary Embed for Confluence from its [Atlassian Marketplace listing](https://marketplace.atlassian.com/apps/1228767/apiary-embed-for-confluence), or by browsing for it from inside your Confluence instance.

## Requirements

* Confluence Cloud — this app runs on the Forge platform, which doesn't support Data Center
* Site admin or app management permission to install
* Approval of the permissions the app requests: outbound network access to Apiary's domains (`*.apiary.io`, used to fetch and render the embedded documentation) and Forge's built-in licensing

## Install Apiary Embed for Confluence

<Tabs>
  <Tab title="From the Marketplace listing">
    <Steps>
      <Step title="Open the listing">
        Go to the [Apiary Embed for Confluence listing](https://marketplace.atlassian.com/apps/1228767/apiary-embed-for-confluence) and click **Try it free**.
      </Step>

      <Step title="Review and start the trial">
        Select the site to install it on and click **Review**. On the next page, review the requested permissions and click **Start free trial**.
      </Step>
    </Steps>
  </Tab>

  <Tab title="From the Apps menu">
    <Steps>
      <Step title="Open Explore apps">
        In the top-left navigation menu, click <Icon icon="grid-2-plus" /> **Apps**, then choose <Icon icon="store" /> **Explore apps** (or **Explore more apps**).
      </Step>

      <Step title="Find and select the app">
        Search for "Apiary Embed for Confluence", select it, and click **Try it free**.
      </Step>

      <Step title="Review and start the trial">
        Review the site selection and click **Review**. On the next page, review the requested permissions and click **Start free trial**.
      </Step>
    </Steps>
  </Tab>

  <Tab title="From Settings">
    <Steps>
      <Step title="Open Find new apps">
        Log in as a site admin, click <Icon icon="gear" /> **Settings** in the top-right navigation bar, then scroll the left-hand sidebar to **Atlassian Marketplace** and click **Find new apps**.
      </Step>

      <Step title="Find and select the app">
        Search for "Apiary Embed for Confluence", select it, and click **Try it free**.
      </Step>

      <Step title="Review and start the trial">
        Review the site selection and click **Review**. On the next page, review the requested permissions and click **Start free trial**.
      </Step>
    </Steps>
  </Tab>
</Tabs>

See [Usage](/apiary-confluence/usage) for how to add a macro to a page.


# Get started
Source: https://docs.logictwelve.com/apiary-confluence/overview

Get up and running with Apiary Embed for Confluence

Apiary Embed for Confluence is a Forge app with two macros — **Apiary Embed (raw code)** and **Apiary Embed (generate code)** — that render an [Apiary](https://apiary.io) API Project as interactive API documentation, with a human-readable column, a machine column, and a request console, directly inside a Confluence page.

## Who this is for

Teams who document their API in an Apiary API Project and want that documentation visible to the rest of the org in Confluence, instead of linking out to Apiary.

## Prerequisites

* A Confluence Cloud site where you can install marketplace apps (this app runs on Forge, which doesn't support Data Center)
* An Apiary API Project, and either its subdomain or the raw embed script Apiary generates for it

## Get started

<Steps>
  <Step title="Install">
    See [Installation](/apiary-confluence/installation) for how to add Apiary Embed for Confluence from the Atlassian Marketplace.
  </Step>

  <Step title="Add it to a page">
    See [Usage](/apiary-confluence/usage) for how to insert and set up a macro.
  </Step>

  <Step title="Configure">
    See [Configuration](/apiary-confluence/configuration) for the full reference of every field on both macros.
  </Step>
</Steps>

<Tip>
  Need help? Visit the [Apiary Embed for Confluence service desk portal](https://logictwelve.atlassian.net/servicedesk/customer/portal/3).
</Tip>


# Pricing
Source: https://docs.logictwelve.com/apiary-confluence/pricing





# Try Now
Source: https://docs.logictwelve.com/apiary-confluence/try-now





# Usage
Source: https://docs.logictwelve.com/apiary-confluence/usage

Use Apiary Embed for Confluence day to day

Page viewers see the Apiary API Project rendered in place — a human-readable column, a machine column with the raw API Blueprint, and a request console — with no Confluence-specific chrome around it.

If the macro doesn't have a usable configuration yet, viewers see a configuration warning instead. If the site doesn't have an active license, they see a license warning instead — see [Licensing](#licensing).

## Choosing a macro

There are two macros to choose between:

* **Apiary Embed (raw code)** — paste the exact embed script Apiary generates for you (`var embed = new Apiary.Embed({...});`). Use this when you need options that aren't exposed by the generate form, or you're reusing a script you already have.
* **Apiary Embed (generate code)** — provide the API Project subdomain and toggle display options in a form, without writing any code. Use this for the common case.

## Adding the macro to a page

<Steps>
  <Step title="Open the macro browser">
    While editing a page, type `/` or click the **+** in the editing toolbar.
  </Step>

  <Step title="Find and select a macro">
    Search for "Apiary" and select **Apiary Embed (raw code)** or **Apiary Embed (generate code)**:

    <Frame>
      <img alt="Macro picker showing the Apiary Embed macros" />
    </Frame>
  </Step>

  <Step title="Set up the macro">
    Fill in the config form — see [Configuration](/apiary-confluence/configuration) for every field.
  </Step>

  <Step title="Save">
    Click **Save** on the macro, then save the page to make the rendered documentation visible to viewers. Here's how the macro looks once published:

    <Frame>
      <img alt="Rendered Apiary Embed macro on a published Confluence page" />
    </Frame>
  </Step>
</Steps>

## Keeping it updated

Both macros render the Apiary API Project live, in an iframe served by Apiary, every time someone views the page. There's nothing to republish — if you update the API Project in Apiary, the change shows up the next time the page loads.

## Licensing

The app uses Confluence's built-in Marketplace licensing. If a site doesn't have an active license or trial, every instance of either macro shows a license warning instead of rendering.

## Tips

<AccordionGroup>
  <Accordion title="Need an option the generate form doesn't expose">
    Use **Apiary Embed (raw code)** instead, and paste the exact embed script from Apiary's own embed generator.
  </Accordion>

  <Accordion title="Macro feels cramped">
    Confluence pages default to a fixed width. Use the page options menu to switch the page to **Go wide** or **Go full width** instead of changing the macro's own settings.
  </Accordion>

  <Accordion title="Embedded content is cut off">
    Increase the **Height** field on the macro — it sets a fixed iframe height, so content taller than that value is clipped rather than scrolled.
  </Accordion>
</AccordionGroup>


# Configuration
Source: https://docs.logictwelve.com/apidog-embed/configuration

Configure API Docs Embed for Apidog

There's no site-wide settings screen. The macro is configured individually, the first time you insert it on a page and any time afterward you choose to edit it.

## API Docs Embed for Apidog macro

Embeds a published Apidog documentation page on a Confluence page.

| Field            | Required | Notes                                                                                                                                                                                                                                             |
| ---------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **URL Resource** | Yes      | The full URL of the published Apidog documentation page to embed. Must be on the `apidog.com` domain (or a subdomain of it) — other domains show an **Invalid URL Resource** warning. If you omit the protocol, `https://` is added automatically |
| **Height**       | Yes      | Default: `1048px`. Sets the height of the embedded viewer. Accepts any valid CSS height value, for example `800px`                                                                                                                                |

<Frame>
  <img alt="API Docs Embed for Apidog macro configuration form" />
</Frame>

## Permissions

Anyone with edit access to a Confluence page can insert the macro and change its configuration. Page viewers without edit access only see the rendered output.


# FAQ
Source: https://docs.logictwelve.com/apidog-embed/faq

Frequently asked questions about API Docs Embed for Apidog

<AccordionGroup>
  <Accordion title="Does this work with Confluence Data Center, or Cloud only?">
    Cloud only. The app is built on Atlassian's Forge platform, which doesn't support Data Center.
  </Accordion>

  <Accordion title="What can I embed with this macro?">
    Any publicly reachable documentation page hosted on the `apidog.com` domain (or a subdomain of it). The macro renders the URL in place on the Confluence page.
  </Accordion>

  <Accordion title="Does the macro update automatically when my Apidog docs change?">
    Yes. The macro embeds the configured URL live, so changes you publish in Apidog show up the next time someone views the Confluence page.
  </Accordion>

  <Accordion title="Why do I see an &#x22;Invalid URL Resource&#x22; warning?">
    The **URL Resource** field must point to a URL on the `apidog.com` domain. URLs on any other domain are rejected.
  </Accordion>

  <Accordion title="The macro shows a warning instead of rendering — what should I check first?">
    There are three distinct warnings. A **license warning** means the site doesn't have an active license or trial. A configuration warning means the **URL Resource** field is empty. An **Invalid URL Resource** warning means the URL isn't on the `apidog.com` domain. If it looks configured correctly but still won't load, confirm the Apidog page is published and publicly accessible.
  </Accordion>
</AccordionGroup>

<Tip>
  Can't find what you're looking for? Visit the [API Docs Embed for Apidog service desk portal](https://logictwelve.atlassian.net/servicedesk/customer/portal/7).
</Tip>


# Help Center
Source: https://docs.logictwelve.com/apidog-embed/help-center





# Installation
Source: https://docs.logictwelve.com/apidog-embed/installation

Install API Docs Embed for Apidog

Install API Docs Embed for Apidog from its [Atlassian Marketplace listing](https://marketplace.atlassian.com/apps/731469196/api-docs-embed-for-apidog), or by browsing for it from inside your Confluence instance.

## Requirements

* Confluence Cloud — this app runs on the Forge platform, which doesn't support Data Center
* Site admin or app management permission to install
* Approval of the permissions the app requests: outbound network access to `apidog.com` (to load embedded documentation) and Forge's built-in licensing

## Install API Docs Embed for Apidog

<Tabs>
  <Tab title="From the Marketplace listing">
    <Steps>
      <Step title="Open the listing">
        Go to the [API Docs Embed for Apidog listing](https://marketplace.atlassian.com/apps/731469196/api-docs-embed-for-apidog) and click **Try it free**.
      </Step>

      <Step title="Review and start the trial">
        Select the site to install it on and click **Review**. On the next page, review the requested permissions and click **Start free trial**.
      </Step>
    </Steps>
  </Tab>

  <Tab title="From the Apps menu">
    <Steps>
      <Step title="Open Explore apps">
        In the top-left navigation menu, click <Icon icon="grid-2-plus" /> **Apps**, then choose <Icon icon="store" /> **Explore apps** (or **Explore more apps**).
      </Step>

      <Step title="Find and select the app">
        Search for "API Docs Embed for Apidog", select it, and click **Try it free**.
      </Step>

      <Step title="Review and start the trial">
        Review the site selection and click **Review**. On the next page, review the requested permissions and click **Start free trial**.
      </Step>
    </Steps>
  </Tab>

  <Tab title="From Settings">
    <Steps>
      <Step title="Open Find new apps">
        Log in as a site admin, click <Icon icon="gear" /> **Settings** in the top-right navigation bar, then scroll the left-hand sidebar to **Atlassian Marketplace** and click **Find new apps**.
      </Step>

      <Step title="Find and select the app">
        Search for "API Docs Embed for Apidog", select it, and click **Try it free**.
      </Step>

      <Step title="Review and start the trial">
        Review the site selection and click **Review**. On the next page, review the requested permissions and click **Start free trial**.
      </Step>
    </Steps>
  </Tab>
</Tabs>

See [Usage](/apidog-embed/usage) for how to add the macro to a page.


# Get started
Source: https://docs.logictwelve.com/apidog-embed/overview

Get up and running with API Docs Embed for Apidog

API Docs Embed for Apidog is a Forge app with a single **API Docs Embed for Apidog** macro that embeds a published Apidog documentation page as a live, interactive viewer directly inside a Confluence page.

## Who this is for

API teams who publish their API documentation in Apidog and want it visible inside Confluence, next to their internal docs, instead of linking out to Apidog.

## Prerequisites

* A Confluence Cloud site where you can install marketplace apps (this app runs on Forge, which doesn't support Data Center)
* A publicly reachable Apidog documentation page URL (on the `apidog.com` domain) for the project you want to embed

## Get started

<Steps>
  <Step title="Install">
    See [Installation](/apidog-embed/installation) for how to add API Docs Embed for Apidog from the Atlassian Marketplace.
  </Step>

  <Step title="Add it to a page">
    See [Usage](/apidog-embed/usage) for how to insert and set up the macro.
  </Step>

  <Step title="Configure">
    See [Configuration](/apidog-embed/configuration) for the full reference of every field.
  </Step>
</Steps>

<Tip>
  Need help? Visit the [API Docs Embed for Apidog service desk portal](https://logictwelve.atlassian.net/servicedesk/customer/portal/7).
</Tip>


# Pricing
Source: https://docs.logictwelve.com/apidog-embed/pricing





# Try Now
Source: https://docs.logictwelve.com/apidog-embed/try-now





# Usage
Source: https://docs.logictwelve.com/apidog-embed/usage

Use API Docs Embed for Apidog day to day

Page viewers see the embedded Apidog documentation page rendered in place, with no Confluence-specific chrome around it.

If the macro doesn't have a usable URL configured, viewers see a configuration warning instead. If the URL isn't on the `apidog.com` domain, they see an invalid URL warning. If the site doesn't have an active license, they see a license warning instead — see [Licensing](#licensing).

## Adding the macro to a page

<Steps>
  <Step title="Open the macro browser">
    While editing a page, type `/` or click the **+** in the editing toolbar.
  </Step>

  <Step title="Find and select the macro">
    Search for "Apidog" and select **API Docs Embed for Apidog**:

    <Frame>
      <img alt="Macro picker showing the API Docs Embed for Apidog macro" />
    </Frame>
  </Step>

  <Step title="Set up the macro">
    Fill in the **URL Resource** and **Height** fields — see [Configuration](/apidog-embed/configuration) for details.
  </Step>

  <Step title="Save">
    Click **Save** on the macro, then save the page to make the embedded documentation visible to viewers. Here's how the macro looks once published:

    <Frame>
      <img alt="Rendered API Docs Embed for Apidog macro on a published Confluence page" />
    </Frame>
  </Step>
</Steps>

## Keeping it updated

The macro embeds the configured URL live, so any changes you publish in Apidog show up the next time someone views the Confluence page. There's nothing to republish on the Confluence side — only the **URL Resource** or **Height** fields need to be revisited if you reconfigure the macro itself.

## Licensing

The app uses Confluence's built-in Marketplace licensing. If a site doesn't have an active license or trial, every instance of the macro shows a license warning instead of rendering.

## Tips

<AccordionGroup>
  <Accordion title="Content isn't visible inside the macro">
    Confirm the **URL Resource** points to a published, publicly accessible Apidog documentation page — pages that require Apidog sign-in won't render inside the iframe.
  </Accordion>

  <Accordion title="Macro shows an &#x22;Invalid URL Resource&#x22; warning">
    The URL must be on the `apidog.com` domain or a subdomain of it. URLs on any other domain are rejected.
  </Accordion>

  <Accordion title="Embedded content is cut off or has extra empty space below it">
    The macro doesn't auto-resize to its content. Adjust the **Height** field in the macro configuration to match the embedded page.
  </Accordion>
</AccordionGroup>


# Logic Twelve documentation
Source: https://docs.logictwelve.com/index

Documentation for the Logic Twelve family of apps

Logic Twelve builds focused apps for API documentation and link management, including marketplace apps for Confluence and Apidog. Pick a product below to get started.

<CardGroup>
  <Card title="Stoplight Elements for Confluence" icon="diagram-project" href="/stoplight-confluence/overview">
    Render OpenAPI specs using Stoplight Elements inside Confluence pages.
  </Card>

  <Card title="Better Swagger UI for Confluence" icon="square-code" href="/swagger-ui-confluence/overview">
    Render OpenAPI and Swagger specs as interactive docs inside Confluence pages.
  </Card>

  <Card title="Pocket Links" icon="link" href="/pocket-links/overview">
    Save, organize, and share links with your team.
  </Card>

  <Card title="API Docs Embed for Apidog" icon="plug" href="/apidog-embed/overview">
    Embed live API documentation from Apidog wherever your team and users need it.
  </Card>

  <Card title="Apiary Embed for Confluence" icon="file-code" href="/apiary-confluence/overview">
    Render Apiary API Blueprint documentation inside Confluence pages.
  </Card>
</CardGroup>

<Tip>
  Need help with any of these apps? Visit the [service desk portal](https://logictwelve.atlassian.net/servicedesk/customer/portals).
</Tip>


# Data Processing Agreement
Source: https://docs.logictwelve.com/legal/dpa

DPA covering all Atlassian Marketplace apps provided by Logic Twelve

*Last updated: June 20, 2026*

**Vendor:** Roman Kobal, trading as "Logic Twelve"

This Data Processing Addendum ("DPA") applies to all Atlassian Marketplace applications provided by Roman Kobal, trading as "Logic Twelve" ("Processor"), and forms an integral part of the [End-User License Agreement](/legal/eula) ("EULA") between the Processor and the entity using the Apps ("Controller").

## 1. Definitions

* **Apps** means any and all applications developed by Logic Twelve and made available via the Atlassian Marketplace.
* **Customer Data** means any personal data processed by the Apps on behalf of the Controller.
* **Forge Platform** means the Atlassian cloud infrastructure used to host and run the Apps.

## 2. Roles and Scope

* **Roles:** The Customer acts as the Data Controller, and Logic Twelve acts as the Data Processor.
* **Scope:** The Processor shall process Customer Data only to provide the functionality of the Apps as installed by the Controller and as instructed through the Apps' settings and configuration.

## 3. Details of Processing

* **Subject Matter:** Provision of software services and functionality within the Atlassian Cloud environment.
* **Duration:** The duration of the App(s) subscription.
* **Nature and Purpose:** Automated programmatic processing of configuration metadata and user context to deliver App features (e.g., embedding external content, data visualization, or workflow automation).
* **Data Categories:** Atlassian Account IDs (AAID), Site URLs, app-specific configuration settings (links, identifiers, preferences), and technical metadata.
* **Data Subjects:** Authorized users of the Controller's Atlassian instance.

## 4. Processor's Obligations

* **Instruction:** The Processor processes data only on documented instructions from the Controller (including instructions via the App's UI).
* **Confidentiality:** Logic Twelve ensures that any personnel or contractors are bound by strict confidentiality obligations.
* **Security:** All Apps are built natively on the Atlassian Forge platform. The Processor leverages Atlassian's enterprise-grade security, encryption, and data residency controls. No Customer Data is stored on external servers managed by Logic Twelve.

## 5. Sub-processors

The Controller grants general authorization to the Processor to engage sub-processors. The primary sub-processor is:

* **Atlassian Pty Ltd:** Provides the hosting, storage (Forge Storage), and execution environment for the Apps.

## 6. Data Subject Rights

The Processor will assist the Controller in responding to requests from individuals exercising their rights under GDPR (e.g., access, deletion) by utilizing the standard tools provided by the Atlassian Forge platform.

## 7. Personal Data Breach

The Processor will notify the Controller without undue delay after becoming aware of a personal data breach involving Customer Data, primarily by relaying information provided by Atlassian regarding the Forge infrastructure.

## 8. Data Deletion

Upon termination of the subscription, Customer Data is handled, retained, and deleted according to Atlassian's standard data retention policies for the Forge platform.


# End-User License Agreement
Source: https://docs.logictwelve.com/legal/eula

EULA covering all Atlassian Marketplace apps provided by Logic Twelve

*Last updated: June 20, 2026*

This End-User License Agreement ("EULA") is a legal agreement between you (either an individual or a single entity) and Roman Kobal, trading as "Logic Twelve" ("Company"). By installing, copying, or using any of the Logic Twelve Atlassian Apps, you strictly agree to the terms of this EULA.

This EULA is a supplement to the Atlassian Marketplace Terms of Use.

## Scope of License

The Company grants You a revocable, non-exclusive, non-transferable, limited license to download, install, and use the Application strictly in accordance with the terms of this Agreement.

## License Restrictions

You may not modify, reverse engineer, decompile, or disassemble the Marketplace Product in whole or in part, or create any derivative works from or sublicense any rights in the Marketplace Product, unless otherwise expressly authorized in writing by the Company.

## Third-Party Services

The Application may display, include, or make available third-party content (including data, information, applications, and other products or services) or provide links to third-party websites or services. You acknowledge and agree that the Company shall not be responsible for any Third-party Services, including their accuracy, completeness, timeliness, validity, copyright compliance, legality, decency, quality, or any other aspect thereof. The Company does not assume and shall not have any liability or responsibility to You or any other person or entity for any Third-party Services.

## No Warranties

The Application is provided to You "AS IS" and "AS AVAILABLE" and with all faults and defects without warranty of any kind. To the maximum extent permitted under applicable law, the Company, on its own behalf and on behalf of its affiliates and its and their respective licensors and service providers, expressly disclaims all warranties, whether express, implied, statutory, or otherwise, with respect to the Application, including all implied warranties of merchantability, fitness for a particular purpose, title, and non-infringement, and warranties that may arise out of course of dealing, course of performance, usage, or trade practice.

## Limitation of Liability

To the maximum extent permitted by applicable law, in no event shall the Company or its suppliers be liable for any special, incidental, indirect, or consequential damages whatsoever (including, but not limited to, damages for loss of profits, loss of data or other information, for business interruption, for personal injury, loss of privacy arising out of or in any way related to the use of or inability to use the Application, third-party software and/or third-party hardware used with the Application, or otherwise in connection with any provision of this EULA), even if the Company or any supplier has been advised of the possibility of such damages and even if the remedy fails of its essential purpose.

## Governing Law

This Agreement shall be governed by and construed in accordance with the laws of Poland. Any disputes arising under or in connection with this EULA shall be subject to the exclusive jurisdiction of the courts located in Poland.


# Data Security & Privacy Statement
Source: https://docs.logictwelve.com/legal/security-privacy

How Logic Twelve secures and processes Customer Data across all apps

*Last updated: June 20, 2026*

Protecting your data and your privacy is a high priority and is very important to us. Roman Kobal, trading as "Logic Twelve" ("Logic Twelve"), adheres to a strict policy for ensuring the security and privacy of your data, in particular your personally identifiable information (such as full name, address, e-mail address, and/or other identifiable information, collectively "Personal Data").

## Overview

We provide hosted services ("Cloud Applications") for Atlassian Cloud Products. The Applications are delivered through the Atlassian Forge App framework ("Atlassian Forge"). Cloud Applications can be identified by the "Cloud" category in the corresponding Atlassian Marketplace listing.

This Data Security and Privacy Statement only applies to our Cloud Applications.

In the following, all data created by an Atlassian Cloud Product end user and stored within the Atlassian Product are defined as "Customer Data".

## Data Security

We maintain state-of-the-art technical and organizational measures in order to ensure data security, in particular for the protection of your Personal Data. These measures are updated from time to time in order to remain state-of-the-art. If you are interested in our data security concept please contact us.

## Data Storage

Unless otherwise stated below, our Cloud Applications do not store Customer Data locally, but store Customer Data in the corresponding Atlassian Cloud Product.

Exceptions applying to all Applications:

* **Account Data:** Our Applications store data provided and generated by Atlassian, that are required for license validation, contract administration and communication with the customer instance.
* **Session Data:** Our Apps store data resulting from the customer's use of the service and is distinguished from Customer Uploaded Data. This includes, for example, usage statistics of service functionality.
* **Support Data:** Our Apps may offer a problem report functionality which can be triggered in the respective apps. If an app offers such functionality, it allows you to automatically report the error to our support team. This functionality will collect relevant support data (e.g. Account Data, Operation Data, Customer Uploaded Data) from our systems and will create a support ticket in our support system on behalf of your users' email address. This data will be stored in the same data location that executed the operation, but also downloaded to our secure support environment by a member of our support team.

## Access to Customer Data

Only authorized Logic Twelve employees and subcontractors from our support and development teams have access to Customer Data. Such subcontractors are contractually bound to the same data security and privacy standards that apply to us.

## End of Subscription

If a customer unsubscribes from our Apps, we mark stored Customer Data for deletion. The data is deleted after 60 days at the latest if the customer does not re-subscribe. However, the customer can contact us to ask for an earlier deletion.

## Legal Basis for Processing (GDPR)

If you are an individual in the European Economic Area (EEA) or the United Kingdom (UK), we collect and process your Personal Data only where we have legal bases for doing so under applicable EU and UK laws. Our legal bases include processing that is:

* Necessary to fulfill our contractual obligations to you and provide the Apps.
* Necessary for our legitimate interests (e.g., to improve our Apps, provide technical support, and maintain security).

## Your Privacy Rights

Depending on your location, you may have the following rights regarding your Personal Data:

* **Right of Access & Portability:** You can request a copy of the Personal Data we hold about you.
* **Right to Rectification:** You can ask us to correct or update inaccurate data.
* **Right to Erasure ("Right to be Forgotten"):** You can request that we delete your Personal Data, subject to certain legal exceptions.
* **Right to Restrict or Object:** You have the right to object to or ask us to restrict the processing of your data.

If you wish to exercise any of these rights, please contact us using the details below. We will respond to your request within the timeframe required by applicable law.

## U.S. State Privacy Laws (CCPA/CPRA)

Under the California Consumer Privacy Act (CCPA) and similar state laws, residents of certain U.S. states have specific rights regarding their personal information. Logic Twelve does not sell your Personal Data to third parties. We also do not share your Personal Data for cross-context behavioral advertising.

## Children's Privacy

Our Apps are designed for business professionals and are not intended for use by anyone under the age of 16. We do not knowingly collect Personal Data from children. If we become aware that a child has provided us with Personal Data, we will take steps to delete such information.

## Changes to This Statement

We may update this Data Security and Privacy Statement from time to time. We will notify you of any changes by posting the new Statement on this page and updating the "Last updated" date.

## Contact Us

If you have any questions, concerns, or requests regarding this Privacy Statement or our data practices, please contact us via email: <ObfuscatedEmail />.


# Service Level Agreement
Source: https://docs.logictwelve.com/legal/sla

Support standards and service commitments for all Atlassian Marketplace apps provided by Logic Twelve

*Last updated: June 20, 2026*

This SLA outlines the support standards and service commitments for all Atlassian Marketplace applications provided by Roman Kobal, trading as "Logic Twelve" ("Logic Twelve").

## 1. Service Availability (Uptime)

Our apps are built natively on the Atlassian Forge platform. Therefore:

* **Infrastructure Availability:** The uptime and availability of the Apps are governed by Atlassian's Cloud Service Availability. Logic Twelve does not manage the underlying hosting infrastructure and is not liable for Atlassian platform outages.
* **App Functionality:** We commit to maintaining the App code to ensure compatibility with the latest Atlassian Cloud updates.

## 2. Support Channels & Hours

Users can report issues or request assistance through the following channels:

* **Support Portal:** [logictwelve.atlassian.net/servicedesk/customer/portals](https://logictwelve.atlassian.net/servicedesk/customer/portals)
* **Email:** <ObfuscatedEmail />
* **Business Hours:** Monday – Friday, 09:00 – 17:00 (CET/CEST), excluding Polish public holidays.

## 3. Incident Severity & Response Times

We aim to acknowledge all requests within 24-48 business hours. For technical incidents, we prioritize based on severity:

| Severity      | Description                                                         | Initial Response      |
| ------------- | ------------------------------------------------------------------- | --------------------- |
| L1 - Critical | App is completely non-functional for all users (Production outage). | \< 24 Business Hours  |
| L2 - High     | Significant feature is broken, but a workaround exists.             | \< 48 Business Hours  |
| L3 - Medium   | Minor bug or functional issue with limited impact.                  | \< 3-5 Business Days  |
| L4 - Low      | Feature requests, general questions, or cosmetic UI issues.         | \< 5-10 Business Days |

## 4. Maintenance and Updates

* **Emergency Maintenance:** In case of critical security vulnerabilities, updates may be deployed immediately.
* **Scheduled Updates:** Minor updates and feature releases are deployed during low-traffic periods to minimize disruption. Since Forge apps update automatically in the background, no manual action is usually required from the customer.

## 5. Exclusions

This SLA does not apply to:

* Issues caused by the customer's misconfiguration or unauthorized modifications.
* Outages of third-party services integrated via the App.
* Failures of the Atlassian Cloud environment itself.
* Beta or "Early Access" versions of the Apps.


# FAQ
Source: https://docs.logictwelve.com/pocket-links/faq

Frequently asked questions about Pocket Links

<AccordionGroup>
  <Accordion title="Who can see the links I save?">
    It depends on the category's visibility. Links in a **public** category are visible to everyone with access to Pocket Links. Links in a **private** category are visible only to its owner and Jira admins. See [Permissions](/pocket-links/usage#permissions) for the full breakdown.
  </Accordion>

  <Accordion title="Is there a limit on how many links or categories I can save?">
    No. Pocket Links doesn't cap the number of categories, links, or favorites — they're just paginated in the UI as the list grows.
  </Accordion>

  <Accordion title="Can I export my saved links?">
    Not currently. There's no built-in export feature.
  </Accordion>

  <Accordion title="A saved link isn't showing up — what should I check first?">
    Clear any active **Search**, **Category**, **VPN**, or **SSO** filters — they combine, so an unrelated filter can hide a link you're looking for. If it's still missing, confirm the link's category is one you have access to: links in a private category are only visible to its owner and admins.
  </Accordion>
</AccordionGroup>

<Tip>
  Can't find what you're looking for? Visit the [Pocket Links service desk portal](https://logictwelve.atlassian.net/servicedesk/customer/portal/40).
</Tip>


# Help Center
Source: https://docs.logictwelve.com/pocket-links/help-center





# Installation
Source: https://docs.logictwelve.com/pocket-links/installation

Install Pocket Links

Install Pocket Links from its [Atlassian Marketplace listing](https://marketplace.atlassian.com/apps/1494659828/pocket-links), or by browsing for it from inside your Jira instance. Once installed, it appears as **Pocket Links** in the Jira global sidebar for everyone on the site.

## Requirements

* A Jira Cloud site
* Jira admin permissions to install apps
* Approval of the permissions Pocket Links requests: storage for app data, and read-only access to Jira users and work items

## Install Pocket Links

<Tabs>
  <Tab title="From the Marketplace listing">
    <Steps>
      <Step title="Open the listing">
        Go to the [Pocket Links listing](https://marketplace.atlassian.com/apps/1494659828/pocket-links) and click **Get it now**.
      </Step>

      <Step title="Select a site and install">
        Select the site to install it on, review the requested permissions, and click **Install**.
      </Step>
    </Steps>
  </Tab>

  <Tab title="From the Apps menu">
    <Steps>
      <Step title="Open Explore apps">
        In the top navigation bar, click <Icon icon="grid-2-plus" /> **Apps**, then choose <Icon icon="store" /> **Explore apps** (or **Explore more apps**).
      </Step>

      <Step title="Find and select the app">
        Search for "Pocket Links", select it, and click **Try it free**.
      </Step>

      <Step title="Review and start the trial">
        Review the site selection and click **Review**. On the next page, review the requested permissions and click **Start free trial**.
      </Step>
    </Steps>
  </Tab>
</Tabs>

Open **Pocket Links** from the Jira sidebar to verify — an empty **Categories** page confirms the app installed correctly and is ready for [your first category](/pocket-links/usage#categories).


# Get started
Source: https://docs.logictwelve.com/pocket-links/overview

Get up and running with Pocket Links

Pocket Links is a Jira app that gives your team a shared, searchable directory of company links. Links are organized into categories with configurable visibility and edit permissions, and every user has a personal list of favorites.

## Who this is for

Jira teams who want one organized, searchable place for the links they use often — internal tools, VPN-only resources, SSO-protected dashboards, and other links that would otherwise be scattered across wikis and chat messages.

## Prerequisites

* A Jira Cloud site
* A Jira admin to install Pocket Links on your site

## Get started

<Steps>
  <Step title="Install">
    See [Installation](/pocket-links/installation) for how to add Pocket Links to your Jira site.
  </Step>

  <Step title="Create a category and save your first link">
    See [Usage](/pocket-links/usage) for how to set up your first category and add, organize, and share links.
  </Step>
</Steps>

<Tip>
  Need help? Visit the [Pocket Links service desk portal](https://logictwelve.atlassian.net/servicedesk/customer/portal/40).
</Tip>


# Pricing
Source: https://docs.logictwelve.com/pocket-links/pricing





# Try Now
Source: https://docs.logictwelve.com/pocket-links/try-now





# Usage
Source: https://docs.logictwelve.com/pocket-links/usage

Use Pocket Links day to day

Pocket Links has three sections in its sidebar: **Categories**, **Company Links**, and **Favorite Links**. The sidebar also links out to this documentation and to the [help portal](https://logictwelve.atlassian.net/servicedesk/customer/portal/40).

## Categories

Categories are containers for links. Each one has its own visibility setting and controls who can edit the links inside it. Every link has to belong to a category, so create at least one before saving links.

### Category cards

Each card on the Categories page shows:

* Category name
* A **Public** or **Private** visibility badge
* An **Editable By** badge for public categories
* Avatars of any specifically permitted users
* **Edit** and **Delete** buttons, if you have permission

<Frame>
  <img alt="Categories page showing category cards" />
</Frame>

### Adding a category

Click **Add Category** and fill in the form:

| Field              | Required                                   | Notes                                                       |
| ------------------ | ------------------------------------------ | ----------------------------------------------------------- |
| **Category Name**  | Yes                                        | Up to 50 characters                                         |
| **Visibility**     | Yes                                        | **Private** or **Public** — see [Permissions](#permissions) |
| **Editable By**    | Public only                                | **All Admins** or **Specific Users**                        |
| **Specific Users** | When **Editable By** is **Specific Users** | Search and select individual users                          |

With **Visibility** set to **Private**, the form has no **Editable By** field:

<Frame>
  <img alt="Add Category form with Visibility set to Private" />
</Frame>

With it set to **Public**, the **Editable By** field appears:

<Frame>
  <img alt="Add Category form with Visibility set to Public, showing the Editable By field" />
</Frame>

<Note>
  If you close the form after entering data, Pocket Links asks you to confirm before discarding it.
</Note>

### Editing a category

Click **Edit** on a category card to update its name, visibility, or edit permissions. Switching a category from **Public** to **Private** removes any specifically permitted users — only the owner and admins keep access afterward.

### Deleting a category

Click **Delete** on a category card and confirm. **This permanently deletes the category and every link inside it.**

## Company Links

### Browsing links

Links are grouped by category. Categories, and the links inside them, are listed alphabetically. Each link card shows:

* Link name and favicon
* A **VPN** badge, if the link requires a VPN connection
* An **SSO** badge, if the link requires single sign-on
* A star icon if the link is in your favorites

<Frame>
  <img alt="Company Links page showing link cards grouped by category" />
</Frame>

### Saving a link

Click **Add Link** in the top-right corner and fill in the form:

| Field            | Required | Notes                                                                                                              |
| ---------------- | -------- | ------------------------------------------------------------------------------------------------------------------ |
| **Link Name**    | Yes      | Up to 50 characters                                                                                                |
| **URL**          | Yes      | A valid `http://` or `https://` address, up to 2048 characters — see [URL validation rules](#url-validation-rules) |
| **Category**     | Yes      | Searchable dropdown of existing categories                                                                         |
| **Requires VPN** | No       | Turn on if the link only works over VPN                                                                            |
| **Requires SSO** | No       | Turn on if the link requires single sign-on                                                                        |

The favicon is fetched automatically from the URL's domain.

<Frame>
  <img alt="Add Link form" />
</Frame>

<Note>
  If you close the form after entering data, Pocket Links asks you to confirm before discarding it.
</Note>

### Editing and deleting a link

Open the **⋮** menu on a link card. **Edit** and **Delete** only appear if you have edit permissions for that link's category — see [Permissions](#permissions). Deleting a link asks for confirmation first.

### Searching and filtering

Use the controls at the top of the page to narrow the list:

* **Search box** — matches link names and URLs, with a short delay while you type
* **Category filter** — multi-select autocomplete across categories
* **VPN filter** — show only links that require VPN
* **SSO filter** — show only links that require SSO
* **Clear filters** — resets every active filter

Filters combine: picking a category and the VPN filter, for example, shows only VPN-required links in that category. Results are paginated, and filters persist across page changes.

### Starring a link

Open a link's **⋮** menu and choose **Add to Favorites** or **Remove from Favorites**. Favorites are personal — other users can't see what you've starred.

## Favorite Links

This page lists every link you've starred, grouped alphabetically by category. It supports the same **Search**, **Category**, **VPN**, and **SSO** filters as Company Links.

To remove a link from your favorites, open its **⋮** menu and choose **Remove from Favorites**.

## Permissions

### Visibility

| Setting     | Who can see the category and its links  |
| ----------- | --------------------------------------- |
| **Private** | Only the category owner and Jira admins |
| **Public**  | Everyone with access to Pocket Links    |

### Edit permissions

The owner and Jira admins can always edit or delete a category and its links, regardless of any other setting. For **public** categories, **Editable By** controls whether anyone else also gets edit access:

| Editable By        | Who else can edit links                                          |
| ------------------ | ---------------------------------------------------------------- |
| **All Admins**     | No one beyond the owner and admins                               |
| **Specific Users** | A hand-picked list of users, in addition to the owner and admins |

Private categories don't have an **Editable By** option — only the owner and admins can edit or view them.

### What each role can do

| Action                      | Owner | Specific user (public category) | Admin | Other user |
| --------------------------- | ----- | ------------------------------- | ----- | ---------- |
| View public category links  | ✓     | ✓                               | ✓     | ✓          |
| View private category links | ✓     | —                               | ✓     | —          |
| Add / edit / delete links   | ✓     | ✓                               | ✓     | —          |
| Edit category settings      | ✓     | —                               | ✓     | —          |
| Delete category             | ✓     | —                               | ✓     | —          |

## URL validation rules

When adding or editing a link, the URL must:

* Start with `http://` or `https://`
* Contain a valid hostname (`http:///something`, with no host, is rejected)
* Not contain credentials (`http://user:pass@host` is rejected)
* Not contain spaces in the host part

## Tips

<AccordionGroup>
  <Accordion title="Quickly focus on one team's links">
    Use the **Category** filter on the Company Links page to narrow the list to a single team's links.
  </Accordion>

  <Accordion title="Find links that need both VPN and SSO">
    Turn on the **VPN** and **SSO** filters at the same time to find links that require both.
  </Accordion>

  <Accordion title="Use Favorite Links as your shortcut list">
    Star anything you visit regularly — your **Favorite Links** page is the fastest way back to it.
  </Accordion>

  <Accordion title="Delegate a category to its team">
    When creating a public category for a specific team, set **Editable By: Specific Users** and add only the people who should manage its links.
  </Accordion>
</AccordionGroup>


# Configuration
Source: https://docs.logictwelve.com/stoplight-confluence/configuration

Configure Stoplight Elements for Confluence

There's no site-wide settings screen. Each macro is configured individually, the first time you insert it on a page and any time afterward you choose to edit it.

## Stoplight Elements macro

Renders any OpenAPI document. Choose **Stoplight document type** first — it determines whether you provide a URL or paste the document directly, and only the matching field is required.

| Field                        | Required              | Notes                                                                                                        |
| ---------------------------- | --------------------- | ------------------------------------------------------------------------------------------------------------ |
| **Stoplight document type**  | —                     | **URL** or **Document**. Default: URL                                                                        |
| **API Description URL**      | When type is URL      | Must start with `http://` or `https://`. Supports documents that use `$ref` to other http(s) documents       |
| **API Description Document** | When type is Document | The OpenAPI document as a YAML string, JSON string, or JavaScript object                                     |
| **Base Path**                | No                    | Helps when **Router** is `history` but the page lives in a subdirectory, e.g. `https://example.com/docs/api` |
| **Try It CORS Proxy**        | No                    | URL of a CORS proxy, prepended to outgoing **Try It** requests                                               |
| **Try It Credential Policy** | No                    | `omit` (default), `include`, or `same-origin` — used for **Try It** fetch calls                              |
| **Layout**                   | No                    | `sidebar` (default) or `stacked` — controls the column design                                                |
| **Router**                   | No                    | `history` (default), `hash`, `memory`, or `static` — controls how in-page navigation works                   |
| **Filter**                   | No                    | **Hide Internal** — filter out content marked `x-internal`. **Hide Try It** — hide the Try It console        |

With **Stoplight document type** set to **URL**, the form shows the **API Description URL** field:

<Frame>
  <img alt="Stoplight Elements macro configuration form with document type set to URL" />
</Frame>

With it set to **Document**, the **API Description URL** field is replaced by the **API Description Document** text area:

<Frame>
  <img alt="Stoplight Elements macro configuration form with document type set to Document" />
</Frame>

## Stoplight Elements Dev Portal macro

Renders a full project hosted on Stoplight's platform. Requires a paid plan on [stoplight.io](https://stoplight.io).

| Field                        | Required | Notes                                                                                                                                                                                                                                                   |
| ---------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Project ID**               | Yes      | Found on the Project Settings screen in Stoplight                                                                                                                                                                                                       |
| **Platform URL**             | Yes      | Defaults to `https://stoplight.io/` — most people can leave this as is; some enterprise customers need to change it                                                                                                                                     |
| **Base Path**                | No       | Same purpose as the Elements macro's Base Path                                                                                                                                                                                                          |
| **Try It CORS Proxy**        | No       | Same purpose as the Elements macro's CORS Proxy                                                                                                                                                                                                         |
| **Try It Credential Policy** | No       | `omit` (default), `include`, or `same-origin`                                                                                                                                                                                                           |
| **Router**                   | No       | `hash` (default), `history`, `memory`, or `static`                                                                                                                                                                                                      |
| **Filter**                   | No       | **Collapse Table Of Contents** — stop the table of contents auto-expanding folders and endpoint lists, useful for large projects. **Hide Mocking** — disable mocking options and remove mock server mentions. **Hide Try It** — hide the Try It console |

The full config form for the Dev Portal macro:

<Frame>
  <img alt="Stoplight Elements Dev Portal macro configuration form" />
</Frame>

## Permissions

Anyone with edit access to a Confluence page can insert the macro and change its configuration. Page viewers without edit access only see the rendered output.


# FAQ
Source: https://docs.logictwelve.com/stoplight-confluence/faq

Frequently asked questions about Stoplight Elements for Confluence

<AccordionGroup>
  <Accordion title="Does this work with Confluence Data Center, or Cloud only?">
    Cloud only. The app is built on Atlassian's Forge platform, which doesn't support Data Center.
  </Accordion>

  <Accordion title="Which OpenAPI versions are supported?">
    OpenAPI 2.0 (Swagger), 3.0, and 3.1, via the underlying Stoplight Elements renderer. Documents that use `$ref` to other http(s) documents are also supported.
  </Accordion>

  <Accordion title="Does the macro update automatically when the spec or Stoplight project changes?">
    Yes, if it's configured with a URL (Elements macro) or a Project ID (Dev Portal macro) — both are fetched live on every page view. If you pasted the OpenAPI document directly as text, it's a static snapshot and only updates when you edit the macro and paste in the new version.
  </Accordion>

  <Accordion title="What's the difference between the two macros?">
    **Stoplight Elements** renders any OpenAPI document you give it — useful for specs hosted anywhere, including outside Stoplight's platform. **Stoplight Elements Dev Portal** embeds a project's full hosted dev portal from stoplight.io, and requires a paid Stoplight plan.
  </Accordion>

  <Accordion title="The macro shows a warning instead of rendering — what should I check first?">
    There are two distinct warnings. A **license warning** means the site doesn't have an active license or trial. A **configuration warning** means a required field is empty — the API document (URL or pasted text) for the Elements macro, or the Project ID and Platform URL for the Dev Portal macro. If it looks configured correctly but still won't load, confirm the spec's URL is reachable over plain `http://` or `https://` — Forge apps can only reach an allow-listed set of domains, and while most common top-level domains (`.com`, `.io`, `.dev`, `.app`, and similar) are covered, some country-code domains aren't, so a spec hosted on one of those will fail to fetch. If only the **Try It** console is failing, check the **Try It CORS Proxy** setting.
  </Accordion>
</AccordionGroup>

<Tip>
  Can't find what you're looking for? Visit the [Stoplight Elements for Confluence service desk portal](https://logictwelve.atlassian.net/servicedesk/customer/portal/5).
</Tip>


# Help Center
Source: https://docs.logictwelve.com/stoplight-confluence/help-center





# Installation
Source: https://docs.logictwelve.com/stoplight-confluence/installation

Install Stoplight Elements for Confluence

Install Stoplight Elements for Confluence from its [Atlassian Marketplace listing](https://marketplace.atlassian.com/apps/1228928/stoplight-elements-for-confluence), or by browsing for it from inside your Confluence instance.

## Requirements

* Confluence Cloud — this app runs on the Forge platform, which doesn't support Data Center
* Site admin or app management permission to install
* Approval of the permissions the app requests: outbound network access (to fetch OpenAPI documents and load the Stoplight Elements UI library from unpkg.com) and Forge's built-in licensing

## Install Stoplight Elements for Confluence

<Tabs>
  <Tab title="From the Marketplace listing">
    <Steps>
      <Step title="Open the listing">
        Go to the [Stoplight Elements for Confluence listing](https://marketplace.atlassian.com/apps/1228928/stoplight-elements-for-confluence) and click **Try it free**.
      </Step>

      <Step title="Review and start the trial">
        Select the site to install it on and click **Review**. On the next page, review the requested permissions and click **Start free trial**.
      </Step>
    </Steps>
  </Tab>

  <Tab title="From the Apps menu">
    <Steps>
      <Step title="Open Explore apps">
        In the top-left navigation menu, click <Icon icon="grid-2-plus" /> **Apps**, then choose <Icon icon="store" /> **Explore apps** (or **Explore more apps**).
      </Step>

      <Step title="Find and select the app">
        Search for "Stoplight Elements for Confluence", select it, and click **Try it free**.
      </Step>

      <Step title="Review and start the trial">
        Review the site selection and click **Review**. On the next page, review the requested permissions and click **Start free trial**.
      </Step>
    </Steps>
  </Tab>

  <Tab title="From Settings">
    <Steps>
      <Step title="Open Find new apps">
        Log in as a site admin, click <Icon icon="gear" /> **Settings** in the top-right navigation bar, then scroll the left-hand sidebar to **Atlassian Marketplace** and click **Find new apps**.
      </Step>

      <Step title="Find and select the app">
        Search for "Stoplight Elements for Confluence", select it, and click **Try it free**.
      </Step>

      <Step title="Review and start the trial">
        Review the site selection and click **Review**. On the next page, review the requested permissions and click **Start free trial**.
      </Step>
    </Steps>
  </Tab>
</Tabs>

See [Usage](/stoplight-confluence/usage) for how to add the macro to a page.


# Get started
Source: https://docs.logictwelve.com/stoplight-confluence/overview

Get up and running with Stoplight Elements for Confluence

Stoplight Elements for Confluence is a Forge app with two macros that render API documentation directly inside a Confluence page: a **Stoplight Elements** macro for any OpenAPI document, and a **Stoplight Elements Dev Portal** macro for a project hosted on Stoplight's platform.

## Who this is for

API teams who keep an OpenAPI document — reachable over HTTP, or pasted directly into the macro — and want a readable, three-panel reference (endpoints, schemas, and a **Try It** console) inside Confluence instead of a link out to another tool. Teams already on a paid Stoplight.io plan can instead embed their full hosted dev portal.

## Prerequisites

* A Confluence Cloud site where you can install marketplace apps (this app runs on Forge, which doesn't support Data Center)
* For the **Stoplight Elements** macro: an OpenAPI 2.0, 3.0, or 3.1 document, as a URL or pasted YAML/JSON
* For the **Stoplight Elements Dev Portal** macro: a project ID from a paid Stoplight.io plan

## Get started

<Steps>
  <Step title="Install">
    See [Installation](/stoplight-confluence/installation) for how to add Stoplight Elements for Confluence from the Atlassian Marketplace.
  </Step>

  <Step title="Add it to a page">
    See [Usage](/stoplight-confluence/usage) for how to insert and set up the macro.
  </Step>

  <Step title="Configure">
    See [Configuration](/stoplight-confluence/configuration) for the full reference of every field.
  </Step>
</Steps>

<Tip>
  Need help? Visit the [Stoplight Elements for Confluence service desk portal](https://logictwelve.atlassian.net/servicedesk/customer/portal/5).
</Tip>


# Pricing
Source: https://docs.logictwelve.com/stoplight-confluence/pricing





# Try Now
Source: https://docs.logictwelve.com/stoplight-confluence/try-now





# Usage
Source: https://docs.logictwelve.com/stoplight-confluence/usage

Use Stoplight Elements for Confluence day to day

Page viewers see either a three-panel API reference (endpoints, schemas, and a **Try It** console) from the **Stoplight Elements** macro, or a full embedded dev portal from the **Stoplight Elements Dev Portal** macro — rendered in place, with no Confluence-specific chrome around it.

If a macro is missing required configuration, viewers see a configuration warning instead. If the site doesn't have an active license, they see a license warning instead — see [Licensing](#licensing).

## Adding the macro to a page

<Steps>
  <Step title="Open the macro browser">
    While editing a page, type `/` or click the **+** in the editing toolbar.
  </Step>

  <Step title="Find and select the macro">
    Search for "Stoplight Elements" and select **Stoplight Elements** or **Stoplight Elements Dev Portal**:

    <Frame>
      <img alt="Macro picker showing the Stoplight Elements macro" />
    </Frame>
  </Step>

  <Step title="Set up the macro">
    Fill in the config form — see [Configuration](/stoplight-confluence/configuration) for every field.
  </Step>

  <Step title="Save">
    Click **Save** on the macro, then save the page to make the rendered documentation visible to viewers. Here's how the Elements macro looks once published:

    <Frame>
      <img alt="Rendered Stoplight Elements macro on a published Confluence page" />
    </Frame>
  </Step>
</Steps>

## Keeping it updated

How the macro stays current depends on what you pointed it at:

* **API Description URL** (Elements macro) or **Project ID** (Dev Portal macro) — fetched live every time someone views the page, so changes to the underlying spec or Stoplight project show up automatically. There's nothing to republish.
* **API Description Document** (pasted YAML/JSON, Elements macro only) — stored as a static snapshot in the macro's configuration. It only changes when you reopen the macro and paste in the updated content.

## Licensing

The app uses Confluence's built-in Marketplace licensing. If a site doesn't have an active license or trial, every instance of either macro shows a license warning instead of rendering.

## Tips

<AccordionGroup>
  <Accordion title="Spec isn't publicly reachable">
    Use **Document** instead of **URL** on the Elements macro and paste the OpenAPI YAML or JSON directly into the config.
  </Accordion>

  <Accordion title="Macro feels cramped">
    Confluence pages default to a fixed width. Use the page options menu to switch the page to **Go wide** or **Go full width** instead of changing the macro's own settings.
  </Accordion>

  <Accordion title="Read-only audience">
    Turn on **Hide Try It** in **Filter** to remove the interactive console and present a reference-only view.
  </Accordion>
</AccordionGroup>


# Configuration
Source: https://docs.logictwelve.com/swagger-ui-confluence/configuration

Configure Better Swagger UI for Confluence

There's no site-wide settings screen. The macro is configured individually, the first time you insert it on a page and any time afterward you choose to edit it.

## Better Swagger UI macro

Renders an OpenAPI or Swagger document as an interactive Swagger UI panel. Choose **OpenAPI document type** first — it determines whether you provide a URL or paste the document directly, and only the matching field is required.

| Field                          | Required                      | Notes                                                                                                                                                                                                                        |
| ------------------------------ | ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **OpenAPI document type**      | —                             | **URL** or **Content**. Default: URL                                                                                                                                                                                         |
| **URL**                        | When type is URL              | Must start with `http://` or `https://`                                                                                                                                                                                      |
| **Content**                    | When type is Content          | The OpenAPI/Swagger document as a JSON or YAML string. Not validated — invalid content fails silently in the viewer                                                                                                          |
| **Authorization**              | No                            | **none** (default), **Basic**, or **Api Key** — pre-fills credentials so Swagger UI can authorize **Try it out** requests automatically on load                                                                              |
| **Login** / **Password**       | When Authorization is Basic   | Stored in the macro config                                                                                                                                                                                                   |
| **Api Key**                    | When Authorization is Api Key | Stored in the macro config                                                                                                                                                                                                   |
| **Validator URL**              | No                            | Default: `https://validator.swagger.io/validator`. Clear it to disable the validation badge                                                                                                                                  |
| **Layout**                     | No                            | Default: `BaseLayout` — the name of a Swagger UI plugin component to use as the top-level layout. Leave as is unless a custom plugin registers another layout                                                                |
| **Default Model Expand Depth** | No                            | Default: `1`. How many levels of a schema model are expanded by default; `-1` expands fully                                                                                                                                  |
| **Filter**                     | No                            | Default: empty (disabled). When set, shows a filter box in the top bar pre-filled with this value                                                                                                                            |
| **Expansion**                  | No                            | `list` (default), `full`, or `none` — default expansion of tags and operations                                                                                                                                               |
| **Model Rendering**            | No                            | `example` (default) or `alpha` — which tab is active by default in the request/response body section                                                                                                                         |
| **Supported Submit Methods**   | No                            | Multi-select of `get`, `put`, `post`, `delete`, `options`, `head`, `patch`, `trace`. Default: all selected. Removing a method hides **Try it out** for operations of that method only — it doesn't remove them from the list |
| **Display**                    | No                            | Checkboxes, all off by default — see below                                                                                                                                                                                   |

With **OpenAPI document type** set to **URL**, the form shows the **URL** field:

<Frame>
  <img alt="Better Swagger UI macro configuration form with document type set to URL" />
</Frame>

With it set to **Content**, the **URL** field is replaced by the **Content** text area:

<Frame>
  <img alt="Better Swagger UI macro configuration form with document type set to Content" />
</Frame>

### Display options

| Option                       | Default | Effect                                                                                             |
| ---------------------------- | ------- | -------------------------------------------------------------------------------------------------- |
| **Display Operation Id**     | Off     | Shows the spec's `operationId` alongside each operation name                                       |
| **Display Request Duration** | Off     | Shows elapsed time after a **Try it out** request completes                                        |
| **Show Extensions**          | Off     | Shows vendor extension (`x-`) fields on operations, parameters, responses, and schemas             |
| **Show Common Extensions**   | Off     | Shows parameter validation constraints (`pattern`, `maxLength`, `minLength`, `maximum`, `minimum`) |
| **Request Snippets Enabled** | Off     | Replaces the legacy curl snippet with the richer multi-language request snippet panel              |

<Frame>
  <img alt="Better Swagger UI macro configuration Display options" />
</Frame>

Fields left empty, or checkboxes left unchecked, aren't saved to the macro's config — Swagger UI falls back to its own built-in defaults for anything not explicitly set.

## Permissions

Anyone with edit access to a Confluence page can insert the macro and change its configuration. Page viewers without edit access only see the rendered output.


# FAQ
Source: https://docs.logictwelve.com/swagger-ui-confluence/faq

Frequently asked questions about Better Swagger UI for Confluence

<AccordionGroup>
  <Accordion title="Does this work with Confluence Data Center, or Cloud only?">
    Cloud only. The app is built on Atlassian's Forge platform, which doesn't support Data Center.
  </Accordion>

  <Accordion title="Which OpenAPI/Swagger versions are supported?">
    OpenAPI 2.0 (Swagger) and 3.0, via the underlying Swagger UI renderer.
  </Accordion>

  <Accordion title="Does the macro update automatically when the spec changes?">
    Yes, if it's configured with a URL — it's fetched live on every page view. If you pasted the document directly as **Content**, it's a static snapshot and only updates when you edit the macro and paste in the new version.
  </Accordion>

  <Accordion title="Can I pre-fill credentials for Try it out requests?">
    Yes. Set **Authorization** to **Basic** to provide a login and password, or **Api Key** to provide a key. Swagger UI applies them automatically when the page loads, so viewers don't need to authorize manually.
  </Accordion>

  <Accordion title="The macro shows a warning instead of rendering — what should I check first?">
    There are two distinct warnings. A **license warning** means the site doesn't have an active license or trial. A **configuration warning** means the macro doesn't have a usable OpenAPI document yet — check that **URL** or **Content** is filled in for the selected **OpenAPI document type**. If it looks configured correctly but still won't load, confirm the spec's URL is reachable over plain `http://` or `https://` — Forge apps can only reach an allow-listed set of domains, and while most common top-level domains (`.com`, `.io`, `.dev`, `.app`, and similar) are covered, some country-code domains aren't, so a spec hosted on one of those will fail to fetch.
  </Accordion>
</AccordionGroup>

<Tip>
  Can't find what you're looking for? Visit the [Better Swagger UI for Confluence service desk portal](https://logictwelve.atlassian.net/servicedesk/customer/portal/4).
</Tip>


# Help Center
Source: https://docs.logictwelve.com/swagger-ui-confluence/help-center





# Installation
Source: https://docs.logictwelve.com/swagger-ui-confluence/installation

Install Better Swagger UI for Confluence

Install Better Swagger UI for Confluence from its [Atlassian Marketplace listing](https://marketplace.atlassian.com/apps/1228800/better-swagger-ui-for-confluence), or by browsing for it from inside your Confluence instance.

## Requirements

* Confluence Cloud — this app runs on the Forge platform, which doesn't support Data Center
* Site admin or app management permission to install
* Approval of the permissions the app requests: outbound network access (to fetch OpenAPI/Swagger documents) and Forge's built-in licensing

## Install Better Swagger UI for Confluence

<Tabs>
  <Tab title="From the Marketplace listing">
    <Steps>
      <Step title="Open the listing">
        Go to the [Better Swagger UI for Confluence listing](https://marketplace.atlassian.com/apps/1228800/better-swagger-ui-for-confluence) and click **Try it free**.
      </Step>

      <Step title="Review and start the trial">
        Select the site to install it on and click **Review**. On the next page, review the requested permissions and click **Start free trial**.
      </Step>
    </Steps>
  </Tab>

  <Tab title="From the Apps menu">
    <Steps>
      <Step title="Open Explore apps">
        In the top-left navigation menu, click <Icon icon="grid-2-plus" /> **Apps**, then choose <Icon icon="store" /> **Explore apps** (or **Explore more apps**).
      </Step>

      <Step title="Find and select the app">
        Search for "Better Swagger UI for Confluence", select it, and click **Try it free**.
      </Step>

      <Step title="Review and start the trial">
        Review the site selection and click **Review**. On the next page, review the requested permissions and click **Start free trial**.
      </Step>
    </Steps>
  </Tab>

  <Tab title="From Settings">
    <Steps>
      <Step title="Open Find new apps">
        Log in as a site admin, click <Icon icon="gear" /> **Settings** in the top-right navigation bar, then scroll the left-hand sidebar to **Atlassian Marketplace** and click **Find new apps**.
      </Step>

      <Step title="Find and select the app">
        Search for "Better Swagger UI for Confluence", select it, and click **Try it free**.
      </Step>

      <Step title="Review and start the trial">
        Review the site selection and click **Review**. On the next page, review the requested permissions and click **Start free trial**.
      </Step>
    </Steps>
  </Tab>
</Tabs>

See [Usage](/swagger-ui-confluence/usage) for how to add the macro to a page.


# Get started
Source: https://docs.logictwelve.com/swagger-ui-confluence/overview

Get up and running with Better Swagger UI for Confluence

Better Swagger UI for Confluence is a Forge app with a single **Better Swagger UI** macro that renders an OpenAPI or Swagger document as an interactive Swagger UI panel — endpoint list, schemas, and a **Try it out** console — directly inside a Confluence page.

## Who this is for

API teams who maintain an OpenAPI 2.0 (Swagger) or 3.0 document and want the familiar Swagger UI reference, including the **Try it out** console, embedded in Confluence instead of linking out to another tool.

## Prerequisites

* A Confluence Cloud site where you can install marketplace apps (this app runs on Forge, which doesn't support Data Center)
* An OpenAPI 2.0 or 3.0 document, as a URL or pasted JSON/YAML
* Optionally, credentials to pre-authorize **Try it out** requests (Basic auth or an API key)

## Get started

<Steps>
  <Step title="Install">
    See [Installation](/swagger-ui-confluence/installation) for how to add Better Swagger UI for Confluence from the Atlassian Marketplace.
  </Step>

  <Step title="Add it to a page">
    See [Usage](/swagger-ui-confluence/usage) for how to insert and set up the macro.
  </Step>

  <Step title="Configure">
    See [Configuration](/swagger-ui-confluence/configuration) for the full reference of every field.
  </Step>
</Steps>

<Tip>
  Need help? Visit the [Better Swagger UI for Confluence service desk portal](https://logictwelve.atlassian.net/servicedesk/customer/portal/4).
</Tip>


# Pricing
Source: https://docs.logictwelve.com/swagger-ui-confluence/pricing





# Try Now
Source: https://docs.logictwelve.com/swagger-ui-confluence/try-now





# Usage
Source: https://docs.logictwelve.com/swagger-ui-confluence/usage

Use Better Swagger UI for Confluence day to day

Page viewers see an interactive Swagger UI panel — endpoint list, schemas, and a **Try it out** console — rendered in place, with no Confluence-specific chrome around it.

If the macro doesn't have a usable OpenAPI document configured, viewers see a configuration warning instead. If the site doesn't have an active license, they see a license warning instead — see [Licensing](#licensing).

## Adding the macro to a page

<Steps>
  <Step title="Open the macro browser">
    While editing a page, type `/` or click the **+** in the editing toolbar.
  </Step>

  <Step title="Find and select the macro">
    Search for "Swagger" and select **Better Swagger UI**:

    <Frame>
      <img alt="Macro picker showing the Better Swagger UI macro" />
    </Frame>
  </Step>

  <Step title="Set up the macro">
    Fill in the config form — see [Configuration](/swagger-ui-confluence/configuration) for every field.
  </Step>

  <Step title="Save">
    Click **Save** on the macro, then save the page to make the rendered documentation visible to viewers. Here's how the macro looks once published:

    <Frame>
      <img alt="Rendered Better Swagger UI macro on a published Confluence page" />
    </Frame>
  </Step>
</Steps>

## Keeping it updated

How the macro stays current depends on what you pointed it at:

* **URL** — fetched live every time someone views the page, so changes to the underlying spec show up automatically. There's nothing to republish.
* **Content** (pasted JSON/YAML) — stored as a static snapshot in the macro's configuration. It only changes when you reopen the macro and paste in the updated content.

## Licensing

The app uses Confluence's built-in Marketplace licensing. If a site doesn't have an active license or trial, every instance of the macro shows a license warning instead of rendering.

## Tips

<AccordionGroup>
  <Accordion title="Spec isn't publicly reachable">
    Use **Content** instead of **URL** and paste the OpenAPI or Swagger document directly into the config.
  </Accordion>

  <Accordion title="Macro feels cramped">
    Confluence pages default to a fixed width. Use the page options menu to switch the page to **Go wide** or **Go full width** instead of changing the macro's own settings.
  </Accordion>

  <Accordion title="Read-only audience">
    Deselect all options in **Supported Submit Methods** to disable **Try it out** for every operation and present a reference-only view.
  </Accordion>

  <Accordion title="Authenticated APIs">
    Set **Authorization** to **Basic** or **Api Key** so Swagger UI pre-fills credentials for **Try it out** requests instead of asking each viewer to authorize manually.
  </Accordion>
</AccordionGroup>