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

# Zivvy Web Forms API

Zivvy (powered by AddMembers/RainMaker) provides APIs for adding web leads and retrieving age groups for martial arts schools. The API exposes 3 endpoints secured with apiKey authentication.

## For AI agents

Programmatically add a web lead (post), add a web lead. Covers 3 operations with apiKey authentication.

## Scope

Does not handle payments, communications, or developer tools - use for crm only.

## Capabilities

- Add a web lead (POST)
- Get age groups
- Integrate Zivvy Web Forms API into automated workflows
- Query and filter Zivvy Web Forms API records by parameters
- Monitor Zivvy Web Forms API operational status and events

## Use cases

### CRM Operations

Use the Zivvy Web Forms API to perform crm operations programmatically. The API provides 3 endpoints covering core functionality including add a web lead (post), add a web lead, get age groups.

Example prompt: Call POST / to add a web lead (post)

### Automated ?Action=Getagegroups Management

Automate ?action=getagegroups operations by combining multiple Zivvy Web Forms API endpoints. Agents can add a web lead and then get age groups in a single workflow.

Example prompt: Call GET / to add a web lead, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Zivvy Web Forms API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey tokens manually.

Example prompt: Search Jentic for 'add a web lead (post)', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/` | Add a web lead (POST) |
| GET | `/` | Add a web lead |
| GET | `/?action=GetAgeGroups` | Get age groups |

## Key resources

- **?Action=Getagegroups** — Operations for ?action=GetAgeGroups

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 48 / 100
- **Maturity:** Foundational
- **Dimensions:**
  - Foundational Compliance: 74 / 100
  - Developer Experience & Jentic Compatibility: 63 / 100
  - AI-Readiness & Agent Experience: 50 / 100
  - Agent Usability: 94 / 100
  - Security: 15 / 100
  - AI Discoverability: 100 / 100
- **View full report:** https://jentic.com/apis/zivvy.com/zivvy/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring Zivvy Web Forms by hand means passing your apikey on the query string against the addmembers.com host and shaping web lead payloads yourself. Through Jentic you install once, import Zivvy Web Forms from the API Directory, store the API key once, and your agent calls it.
- **Permission scoping:** Zivvy Web Forms passes lead details in the request body and query rather than as owned path resources, so scoping is operations-only: limit the agent to the operations it needs, such as adding a web lead or reading age groups. You choose the operations it may call, so anything you leave out is not included unless you add it.
- **Credential handling:** Your Zivvy Web Forms 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 'add a web lead' or 'get age groups', and Jentic returns the matching Zivvy Web Forms operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Hubspot** — Alternative crm API
- **Salesforce** — Alternative crm API
- **Pipedrive** — Complementary crm API
- **Zoho** — Complementary crm API

## FAQ

### What authentication does the Zivvy Web Forms API use?

The Zivvy Web Forms API uses an API key passed in the `apikey` query. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I add a web lead (post) with the Zivvy Web Forms API?

Yes. Use the POST / endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Zivvy Web Forms API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I add a web lead (post) through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'add a web lead (post)'. Jentic returns the matching Zivvy Web Forms API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Zivvy Web Forms API have?

The Zivvy Web Forms API exposes 3 endpoints covering ?action=getagegroups operations.

### Can I limit what my agent is allowed to do with the Zivvy Web Forms API?

Yes. Because Jentic One is self-hosted, you set the rules that decide which Zivvy Web Forms operations your agent may call. Zivvy Web Forms passes lead details in the request body and query rather than as owned path resources, so scoping is operations-only: you can allow the agent to add a web lead while withholding the ability to read age groups, or the reverse. Any operation you do not grant is unavailable to the agent unless you add it.