REST https://api.webynize.com/v1 MCP https://mcp.webynize.com/mcp Auth Authorization: Bearer 120 requests / minute / key

REST API

Send the key from Settings → API Key as a bearer token. A login session token is not accepted, and staff keys are refused. Responses are JSON for this account only.

curl https://api.webynize.com/v1/widgets \
  -H "Authorization: Bearer YOUR_WEBYNIZE_API_KEY"
RequestWhat it does
GET /v1/widget-typesPublished widget types. Use an id with POST /v1/widgets.
GET /v1/widgetsThis account’s widgets, newest first. Optional widget_type_id, project_id, search, page, and per_page (1–100, default 25).
POST /v1/widgetsJSON body name (150 characters or fewer) and widget_type_id. Returns the widget and its customize link.
GET /v1/widgets/{id}One widget you own.
PATCH /v1/widgets/{id}Change name, show_branding, or both. Free accounts keep the badge on.
DELETE /v1/widgets/{id}Deletes the widget. It stops on every site that embeds it.

A missing or revoked key returns HTTP 401. A full account or an ended trial returns HTTP 403 with the reason. Chat setup and the item, project, and response tools are on the MCP page.

MCP tools

These are the operations an assistant can run with the same key. Chat setup for Cursor, Claude, and ChatGPT is on the MCP page.

Search types

search_widget_types, get_widget_type, and get_create_requirements read the published catalog. No key required.

Create

create_widget needs a name (150 characters or fewer) and a widget type id. It returns the embed code and the customize link.

Fill content

add_widget_item, update_widget_item, and delete_widget_item change that widget’s own questions, quotes, plans, and similar rows.

List and update

list_widgets, get_widget, and update_widget cover this account only. Updates go live on every page that already embeds the widget.

Projects

list_projects returns your projects. Pass project_id to update_widget to file a widget under one.

Responses

list_widget_responses reads email signups, quiz leads, and online orders. It does not export or delete them, and it omits IP addresses.

Authentication

Generate the key while logged in as a customer at Settings → API Key. It is shown once and stored hashed. A login session token is not accepted. Admin, support, content creator, and designer keys are refused on every request.

POST https://mcp.webynize.com/mcp
Authorization: Bearer YOUR_WEBYNIZE_API_KEY
Accept: application/json, text/event-stream
Content-Type: application/json

Clients that cannot set a header use https://mcp.webynize.com/mcp/YOUR_WEBYNIZE_API_KEY. Encode | as %7C. The API Key page does this for you. Treat a key in a URL like a password and revoke it if it leaks.

Arguments

Send these inside params.arguments. Fields marked required must be present. The others can be left out.

ToolArguments
search_widget_typesquery required. limit 1–100, default 25.
get_widget_typeid_or_name required. An id such as 19, or a name such as FAQ.
get_create_requirementswidget_type_id required.
get_embed_instructionsplatform such as wordpress or shopify. Omit it to list the platforms. Optional embed_code.
create_widgetwidget_type_id and name required. Name is 150 characters or fewer. Optional template_id.
get_account_statusNone.
list_widgetsOptional widget_type_id, project_id, search, page, and per_page (1–100, default 25).
list_projectsNone.
get_widgetwidget_id required.
update_widgetwidget_id required. Optional name, show_branding, settings, and project_id.
add_widget_itemwidget_id and fields required. Optional collection, default items.
update_widget_itemwidget_id, item_id, and fields required. Optional collection.
delete_widget_itemwidget_id, item_id, and confirm: true required. Optional collection.
delete_widgetwidget_id and confirm: true required.
list_widget_responseswidget_id required. Optional page and per_page (1–100, default 25). Works for email signup forms, quizzes, and online ordering.

Create a widget

Call tools/call with the tool name and arguments. This creates an FAQ named Shipping FAQ on the connected account.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "create_widget",
    "arguments": {
      "widget_type_id": 19,
      "name": "Shipping FAQ"
    }
  }
}

A successful result includes the embed and the customize URL:

<div class='wbnz-faq' data-webynize-id='123'></div>
<script defer src='https://widgets.webynize.com/faq.js'></script>

https://app.webynize.com/update-widget/123

Then add questions with add_widget_item. Call get_embed_instructions with a platform name when you need paste steps.

Errors and limits

ResponseMeaning
HTTP 401, code -32001The account tool was called with a missing, revoked, or non-MCP key. Catalog tools still work with no key.
HTTP 403, code -32001The key belongs to a staff account. Webynize MCP is for customers.
Tool error, widget limitThe account is full, cancelled, or the trial has ended. get_account_status explains the plan.
Branding stays onFree accounts cannot hide the Webynize badge. Paid accounts and active trials can.
120 / minuteRequests are limited per key. Without a key, the limit is per IP address.

delete_widget and delete_widget_item require confirm: true after you agree. Deleting a widget removes it from every site that embeds it.

Resource webynize://product/overview is a short Markdown summary of the product. GET https://mcp.webynize.com/healthz returns {"status":"ok"}.