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

# EndorseFlow API

Jentic publishes the only available OpenAPI specification for EndorseFlow API, keeping it validated and agent-ready. EndorseFlow is a testimonial-collection platform that lets product and marketing teams send testimonial request emails and listen for testimonial events via webhooks. The Zapier-prefixed endpoints make it straightforward to wire EndorseFlow into customer-success or CRM pipelines. Teams use it to automate the moment a happy customer is asked for a quote, video, or written review.

## For AI agents

Send testimonial request emails and register or unregister webhooks for testimonial events from EndorseFlow.

## Scope

Does not handle review moderation, video hosting, or social distribution of testimonials - use for sending testimonial request emails and managing testimonial-event webhooks only.

## Capabilities

- Send a testimonial request email to a named customer recipient
- Register a webhook URL to receive testimonial submission events
- Unregister a webhook when an integration is being torn down
- Trigger collection from a customer-success milestone (e.g. NPS promoter)
- Wire testimonial events into downstream marketing or CRM systems

## Use cases

### NPS-Triggered Testimonial Request

When a customer returns an NPS score of 9 or 10, an agent calls POST `/zapier/testimonials/send-email-request` to ask for a written or video testimonial. This catches the customer at peak satisfaction without requiring a marketer to manually triage NPS responses.

Example prompt: On NPS score >= 9, send a testimonial request email to the customer's address via POST `/zapier/testimonials/send-email-request`

### Webhook-Driven Testimonial Pipeline

Register a webhook with POST `/zapier/webhooks/register` so that EndorseFlow notifies your stack the instant a testimonial is submitted. You can then push the testimonial to a CMS, marketing site, or social scheduler without polling the platform.

Example prompt: Register a webhook pointing at https://example.com/hooks/endorseflow and confirm the registration was accepted

### Integration Teardown

When migrating to a new endpoint or deprecating an integration, call DELETE `/zapier/webhooks/unregister` to stop event delivery cleanly. Avoids the common failure mode of leaving stale webhooks firing into 404s.

Example prompt: Unregister the webhook with id 'wh_old' so it stops firing into the deprecated handler

### Agent-Driven Customer Success Workflow

An AI agent monitoring customer-success signals searches Jentic for 'send a testimonial request', loads EndorseFlow's send-email-request schema, and executes it whenever a milestone fires. This wires testimonial collection into the agent's overall customer-lifecycle automation.

Example prompt: On any customer milestone marked 'champion', send a testimonial request email through EndorseFlow

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/zapier/testimonials/send-email-request` | Send a testimonial request email |
| POST | `/zapier/webhooks/register` | Register a webhook |
| DELETE | `/zapier/webhooks/unregister` | Unregister a webhook |

## Key resources

- **Testimonial Requests** — Send email-based testimonial requests
- **Webhooks** — Register and unregister webhooks for testimonial events

## Why Jentic

- **Setup:** Wiring the EndorseFlow API by hand means setting up its X-API-Key header, formatting its Zapier-style testimonial and webhook calls, and handling your own errors against https://api.endorseflow.com. Through Jentic you install once, import the EndorseFlow API from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** The EndorseFlow API sends its targets in the request body rather than the URL path, so scope it by operation: limit the agent to the operations it needs, such as sending a testimonial request email, and leave webhook registration and unregistration out of the allowed set unless you add them.
- **Credential handling:** Your EndorseFlow 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 'send a testimonial request email' or 'register a testimonial webhook', and Jentic returns the matching EndorseFlow operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Engage.so API** — Engage.so handles outbound user messaging; EndorseFlow specifically asks for testimonials.
- **EngageBay CRM REST API** — EngageBay holds the customer record; EndorseFlow drives testimonial collection from those customers.
- **Endear API** — Endear stores retail customer profiles that an EndorseFlow request can target.

## FAQ

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

EndorseFlow does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call EndorseFlow 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 EndorseFlow API use?

The API uses an API key via the `ApiKeyAuth` scheme. Through Jentic, the key is stored encrypted in the vault and supplied to requests at execution time so the agent never sees the raw value.

### Can I send testimonial request emails through the EndorseFlow API?

Yes. POST `/zapier/testimonials/send-email-request` triggers a templated request email to a specified customer. Pair it with an NPS or customer-success trigger to automate the moment of ask.

### How do I receive testimonial events?

Register a handler URL with POST `/zapier/webhooks/register.` EndorseFlow then POSTs to that URL when a testimonial is submitted. Use DELETE `/zapier/webhooks/unregister` to stop delivery.

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

The OpenAPI spec does not declare rate limits. Treat the email-send endpoint as the most-throttled and back off on HTTP 429 responses; confirm exact limits in the EndorseFlow help centre.

### How do I trigger testimonial requests through Jentic?

Run `pip install jentic`, search 'send a testimonial request email', and Jentic returns POST `/zapier/testimonials/send-email-request` with its input schema. The agent supplies the recipient and executes against base URL https://api.endorseflow.com.

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

Yes. Because you run Jentic One yourself, your own rules decide which EndorseFlow operations and credentials the agent may use, and the API passes its targets in the request body rather than the URL path, so you scope it by operation. You can allow only the operations the agent needs, such as sending a testimonial request email with POST `/zapier/testimonials/send-email-request`, while leaving webhook registration (POST `/zapier/webhooks/register`) and unregistration (DELETE `/zapier/webhooks/unregister`) out of the allowed set unless you explicitly add them. The API key is held by your own instance and injected at execution time, so the agent can only act within the operations you permit.