Embed Pinmarkup on any website.
Collect pinpoint visual feedback, screenshots, and device diagnostics directly on your live site — without client accounts or browser extensions.
How it works
From dashboard setup to live feedback in four simple steps.
Create a review project
Create or open your review project in the Pinmarkup dashboard. Each project gets an isolated feedback board and dedicated widget key.
Add allowed origins & copy key
In the project’s Widget tab, add your staging or production domain to Allowed origins (e.g. https://example.com or https://*.example.com). An empty list blocks all domains.
Paste snippet before </body>
Embed the script tag into your HTML or initialize via @pinmarkup/widget in React, Vue, or Next.js. It loads asynchronously without touching your styles.
Receive pinpoint feedback
Visitors click the launcher to annotate elements or report issues. Feedback lands instantly in your dashboard with full screenshots and metadata.
Add the widget to your stack
Embed with plain HTML or install the first-party TypeScript SDK for modern JavaScript frameworks.
npm i @pinmarkup/widgetPaste this snippet right before the closing </body> tag on any page you want to collect feedback on.
<!-- Pinmarkup Feedback Widget --><script src="https://pinmarkup.com/pinmarkup-widget.js" data-project="sitemap.xml-review" data-key="pmk_YOUR_PROJECT_WIDGET_KEY" data-mode="panel" data-locale="en" data-position="bottom-right" data-accent-color="#38EBAB" data-button-text="Feedback" async></script>Configuration & Attributes
Customize the widget appearance, language, placement, and target portal using data attributes or JS options.
| Attribute / Option | Type | Default | Description |
|---|---|---|---|
| data-projectRequired | string | — | Your project slug (e.g. acme-studio-review). Identifies the review board where submissions land. |
| data-keyRequired | string | — | Public per-project widget key (pmk_...). Safe to embed in client-side code; verified against your Allowed Origins list. |
| data-locale | 'en' | 'tr' | 'en' | Widget interface language. Overrides the project default chosen in the dashboard Widget tab. |
| data-mode | 'panel' | 'toolbar' | 'panel' | 'panel' opens the modern feedback panel. 'toolbar' activates the full legacy in-place visual annotation toolbar. |
| data-position | 'bottom-right' | 'bottom-left' | 'top-right' | 'top-left' | 'bottom-right' | Screen anchor position for the floating widget launcher button. |
| data-accent-color | string (HEX) | #38EBAB | Brand accent color applied to launcher buttons, active indicators, and submit buttons. |
| data-button-text | string | 'Feedback' | Text displayed inside the floating launcher button. |
| data-api-url | string (URL) | Script origin | Custom API base URL. Defaults to the domain hosting the widget script. |
| data-show-pins | boolean | false | When true, renders active pin markers submitted by other team members directly on the page. |
Your project slug (e.g. acme-studio-review). Identifies the review board where submissions land.
Public per-project widget key (pmk_...). Safe to embed in client-side code; verified against your Allowed Origins list.
Widget interface language. Overrides the project default chosen in the dashboard Widget tab.
'panel' opens the modern feedback panel. 'toolbar' activates the full legacy in-place visual annotation toolbar.
Screen anchor position for the floating widget launcher button.
Brand accent color applied to launcher buttons, active indicators, and submit buttons.
Text displayed inside the floating launcher button.
Custom API base URL. Defaults to the domain hosting the widget script.
When true, renders active pin markers submitted by other team members directly on the page.
Tip: You can also manage allowed domains, default language, and rotate your widget key anytime from the project Widget tab in your dashboard.
Language & Internationalization
Deliver a native feedback experience to your clients in their preferred language.
Dashboard Default
Default: EnglishBy default, the widget runs in English. You can change your project’s default language in the dashboard under Project Settings → Widget Tab.
Per-Page Runtime Override
data-locale="tr"To override the language on specific pages or for individual tenant users, provide data-locale="tr" or pass locale: "tr" in the init() options.
<script src="https://pinmarkup.com/pinmarkup-widget.js" data-project="sitemap.xml-review" data-key="pmk_YOUR_PROJECT_WIDGET_KEY" data-locale="tr" async></script>Captured technical metadata
Every submission automatically bundles non-invasive diagnostic details so developers can reproduce bugs instantly.
Detects client browser engine and exact major.minor version.
Underlying operating system and platform build information.
Categorizes client device as desktop, tablet, or mobile handset.
Exact inner browser viewport size at the moment feedback was submitted.
Physical display resolution and device pixel ratio.
Full canonical URL including query parameters and route path.
Vertical and horizontal scroll offset on the document.
High-fidelity rendered screenshot of the viewport with visual highlight.
Exact DOM selector path and normalized percentage coordinates (x, y).
Optional prefilled or reviewer-entered author name and email address.
All technical data is captured locally at the instant of submission without persistent tracking cookies or third-party profiling.
Origin restrictions & public keys
Designed to be safe for public client-side deployment without exposing sensitive dashboard credentials.
Public key is safe to embed
Client-Safe KeyThe widget key (pmk_...) is a public client token. Unlike secret API keys, it is safe to ship in your public HTML or front-end bundles.
Server-side Allowed Origins
Origin-RestrictedProtection is enforced via your Allowed Origins list in the dashboard (e.g. https://example.com or https://*.example.com). Submissions from unauthorized domains are rejected.
Strict rate limiting
10 requests / minBuilt-in rate limiting restricts feedback submissions to 10 per minute per visitor, protecting your project from automated bots and submission floods.
Isolated Shadow DOM
CSS-IsolatedThe widget runs in an isolated Shadow DOM container. It never inherits your site’s CSS rules or pollutes your global window scope.
Important: An empty Allowed Origins list blocks feedback from all domains. Be sure to add your staging or production URLs before testing.
Frequently asked questions
Everything you need to know about integrating and operating the Pinmarkup widget.
No. The widget bundle is under 18 KB gzipped and loads asynchronously (async). It initializes inside a lightweight Shadow DOM after the main page load event, having zero measurable impact on your site’s Core Web Vitals or performance.
