canonical: https://jentic.com/apis/vlow.com.br/vlow-com-br

# Vlow API

Vlow is an HR platform that helps customers facilitate and improve employee management with tools for occupational medicine processes. This API provides webhook triggers for employee and health events. The API exposes 3 endpoints secured with apiKey authentication.

## For AI agents

Programmatically employee created trigger, employee updated to active trigger. Covers 3 operations with apiKey authentication.

## Scope

Does not handle payments, communications, or crm - use for hr and recruiting only.

## Capabilities

- Employee created trigger
- Health certificate created trigger
- Integrate Vlow API into automated workflows
- Query and filter Vlow API records by parameters
- Monitor Vlow API operational status and events

## Use cases

### HR and Recruiting Operations

Use the Vlow API to perform hr recruiting operations programmatically. The API provides 3 endpoints covering core functionality including employee created trigger, employee updated to active trigger, health certificate created trigger.

Example prompt: Call POST `/webhooks/employee-created` to employee created trigger

### Automated Webhooks Management

Automate webhooks operations by combining multiple Vlow API endpoints. Agents can employee updated to active trigger and then health certificate created trigger in a single workflow.

Example prompt: Call POST `/webhooks/employee-updated-active` to employee updated to active trigger, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Vlow 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 'employee created trigger', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/webhooks/employee-created` | Employee created trigger |
| POST | `/webhooks/employee-updated-active` | Employee updated to active trigger |
| POST | `/webhooks/health-certificate-created` | Health certificate created trigger |

## Key resources

- **Webhooks** — Operations for webhooks

## 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:** 66 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 100 / 100
  - Developer Experience & Jentic Compatibility: 63 / 100
  - AI-Readiness & Agent Experience: 47 / 100
  - Agent Usability: 94 / 100
  - Security: 50 / 100
  - AI Discoverability: 100 / 100
- **View full report:** https://jentic.com/apis/vlow.com.br/vlow-com-br/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 Vlow by hand means setting its API key in the Authorization header against api.vlow.com.br and handling the employee webhook payloads yourself. Through Jentic you install once, import Vlow from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** Vlow's webhook operations carry their target in the request body rather than the URL path, so limit the agent to the operations it needs, such as the employee-created or employee-updated-active notifications. You choose the allowed set, so other operations are not included unless you add them.
- **Credential handling:** Your Vlow 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 'notify on a new employee' or 'send a health certificate event', and Jentic returns the matching Vlow operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Greenhouse** — Alternative hr recruiting API
- **Lever** — Alternative hr recruiting API
- **Workday** — Complementary hr recruiting API

## FAQ

### What authentication does the Vlow API use?

The Vlow API uses an API key passed in the `Authorization` header. 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 employee created trigger with the Vlow API?

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

### What are the rate limits for the Vlow 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 employee created trigger through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'employee created trigger'. Jentic returns the matching Vlow API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Vlow API have?

The Vlow API exposes 3 endpoints covering webhooks operations.

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

Yes. Because you run Jentic One yourself, your own rules decide which Vlow operations and credentials the agent can use. Vlow's webhook calls carry their target in the request body rather than the URL path, so you scope the agent to only the notifications it needs, such as POST `/webhooks/employee-created` or POST `/webhooks/employee-updated-active`, and leave POST `/webhooks/health-certificate-created` out. Any operation you do not add stays off limits to the agent.