Amplixa Docs

Widgets (API)

Create, publish, and manage widgets via the public API.

Widgets (API)

For the dashboard product guide, see Widgets overview.

  • List: GET /widgets
  • Get: GET /widgets/:groupId
  • Create: POST /widgets (requires template / goal fields — see OpenAPI)
  • Update draft: PATCH /widgets/:groupId
  • Publish / unpublish: POST .../publish | .../unpublish (needs widget.publish)
  • Delete: DELETE /widgets/:groupId (needs widget.delete)

Creating with an API key returns editorSiteUrl: null. Mint an editor URL from the dashboard with a user JWT (POST .../editor-site-url).

For interaction recipes and template attributes, see Interactions and Templates.

Domains (API)

Register a hostname and verify the Amplixa install script via the public API.

Webhooks (API)

Outbound Amplixa → your HTTPS endpoint with HMAC signatures (REST).

On this page

Widgets (API)