Skip to Content
API ReferenceEndpointsWidget Embed Script

Widget Embed Script

GET/api/v1/widgets/{id}/embed

Returns a JavaScript snippet that creates an iframe-based review widget on your website. The widget displays your reviews in the layout and theme you configured in the Prooflio dashboard.

Authentication

None — this is a public endpoint. No API key is required.

Rate Limit

60 requests per minute per IP address.

Path Parameters

NameTypeDescription
idstringThe unique widget identifier.

Response

Content-Type

Content-Type: application/javascript

CORS

Access-Control-Allow-Origin: *

This endpoint is publicly accessible from any origin so widgets can be embedded on any website.

200 OK

Returns JavaScript code that creates an iframe element and loads the widget.

Usage

Add the following to your website’s HTML where you want the widget to appear:

<div id="prooflio-widget-YOUR_WIDGET_ID"></div> <script src="https://app.prooflio.io/api/v1/widgets/YOUR_WIDGET_ID/embed"></script>

Widget Types

The widget renders according to the type configured in your Prooflio dashboard:

TypeDescription
Wall of LoveA masonry grid displaying multiple reviews.
CarouselA rotating slideshow of reviews.
BadgeA compact rating badge with star count.
Inline SnippetA single review card for inline placement.
Snippets RowA horizontal row of review snippets.

Customization

Widget appearance (colors, typography, dark/light mode) is configured in the Prooflio dashboard under Widgets. Changes take effect immediately — no code changes needed on your website.

Platform Compatibility

The embed script works with any website platform:

  • Static HTML sites
  • React, Vue, Next.js, Svelte
  • WordPress, Webflow, Squarespace
  • Shopify, Wix, Framer, Ghost

Error Responses

StatusDescription
404 Not FoundWidget with the given ID does not exist or is inactive.
429 Too Many RequestsRate limit exceeded.
Last updated on