canonical: https://jentic.com/apis/embedery.com/embedery

# Embedery API

Jentic publishes the only available OpenAPI specification for Embedery API, keeping it validated and agent-ready. Embedery hosts on-site widgets and forms - newsletter sign-ups, exit-intent popups, lead-capture overlays - that are dropped into a website and configured remotely. The API exposes the embed catalogue so agents and integrations can list, create, retrieve, and delete embeds programmatically. Use it to provision lead-capture widgets without clicking through the dashboard.

## For AI agents

List, create, fetch, and delete on-site widgets and lead-capture forms hosted by Embedery so they can be provisioned by an agent.

## Scope

Does not handle email sending, contact storage, or analytics - use for managing on-site widget and form embeds only.

## Capabilities

- List every embed configured in the workspace with its identifier and basic metadata
- Create a new embed for a sign-up form, popup, or banner without using the dashboard
- Retrieve a single embed by ID to inspect its configuration before mutating
- Delete an embed when a campaign or page is retired
- Drive embed lifecycle from infrastructure code or an agent rather than the web UI

## Use cases

### Programmatic Widget Provisioning

Spin up new sign-up forms or popups as part of a campaign deployment instead of configuring each manually in Embedery's dashboard. The API accepts an embed configuration payload and returns the new embed ID, which the deployment pipeline can attach to the relevant landing page. Marketing engineering teams use this to keep widget definitions in version control and roll them out alongside site changes.

Example prompt: POST /embeds with the desired widget configuration and store the returned embed ID in the campaign manifest.

### Embed Inventory Audit

Periodically list all embeds in the workspace to retire orphaned widgets and validate that every active landing page is still tied to a real embed. The list endpoint returns all embeds with their IDs so a job can compare them against the live site map. Operations teams run this to keep the embed footprint in sync with current campaigns.

Example prompt: Call GET /embeds, cross-reference IDs against the active campaign list, and log any embeds that no longer have a referencing page.

### Retiring Old Widgets

When a campaign ends, remove its widget from the site by deleting the embed rather than leaving it disabled in the dashboard. The delete endpoint removes the embed by ID so it stops rendering immediately. This keeps the on-site experience clean and the dashboard inventory accurate.

Example prompt: Call DELETE `/embeds/{id}` for each embed flagged for retirement and confirm the response is successful before updating the campaign manifest.

### Agent-Driven Embed Lifecycle

An agent driving a marketing operations workflow creates new Embedery widgets at campaign launch and deletes them at campaign end, keeping the embed footprint aligned with active programmes. Through Jentic the agent searches by intent, loads the schema, and executes lifecycle calls without bespoke client code. Time to integrate drops from a day of dashboard automation to under an hour.

Example prompt: Search Jentic for 'create a website lead capture widget', execute POST /embeds at launch and DELETE `/embeds/{id}` at end-of-campaign, and log both events to the campaign audit trail.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/embeds` | List all embeds |
| POST | `/embeds` | Create a new embed |
| GET | `/embeds/{id}` | Get an embed by ID |
| DELETE | `/embeds/{id}` | Delete an embed |

## Key resources

- **Embeds** — Create, list, retrieve, and delete on-site widgets and forms

## Why Jentic

- **Setup:** Wiring Embedery by hand means setting up its API key in the Authorization header, formatting embed create, fetch, and delete calls, and handling your own errors against https://api.embedery.com. Through Jentic you install once, import Embedery from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** Embedery puts the embed id in the URL path (`/embeds/{id}`), so a rule can pin your agent to one embed: it can read that embed and nothing else. You choose the operations it may call, so destructive ones like deleting an embed are not included unless you add them.
- **Credential handling:** Your Embedery API key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'list on-site widget embeds' or 'create a new form embed', and Jentic returns the matching Embedery operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **MailerLite API** — Send the captured leads into MailerLite as new subscribers
- **Encharge API** — Marketing automation platform that consumes captured leads
- **Brevo API** — Email marketing platform for newsletters and broadcasts

## FAQ

### Why is there no official OpenAPI spec for Embedery API?

Embedery does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Embedery API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the Embedery API use?

The API uses an API key passed in the Authorization header. Through Jentic, the key is stored encrypted in the vault and injected at execution time, so the raw value never enters an agent's context.

### Can I create a popup with the Embedery API?

Yes. POST /embeds creates a new embed and returns its ID. The configuration payload describes the widget type and content, so popups, sign-up forms, and banners can all be provisioned through the same call.

### How do I list every embed in my workspace through Jentic?

Search Jentic for 'list website embeds', load the schema for GET /embeds, and execute it. The response is the full embed catalogue, ready to feed into an audit job.

### What are the rate limits for the Embedery API?

The OpenAPI spec does not declare quantitative rate limits; limits are enforced by Embedery at the account level. Treat HTTP 429 responses as authoritative and respect any Retry-After header in the response.

### Can I delete an Embedery widget when a campaign ends?

Yes. DELETE `/embeds/{id}` removes the embed so it stops rendering. This is the correct pattern for retiring a campaign rather than disabling the widget in the dashboard.

### Can I limit what my agent is allowed to do with the Embedery API?

Yes. Because you run Jentic One yourself, your own rules decide which Embedery operations and credentials the agent may use, and you can grant only the calls a task needs, such as listing embeds with GET /embeds or reading one with GET `/embeds/{id}.` Since the embed id sits in the URL path, a rule can pin the agent to a single embed so it can read that one and nothing else. Destructive calls like POST /embeds and DELETE `/embeds/{id}` stay out of reach unless you explicitly add them.