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

# Surventrix API

Surventrix surveying and CRM integration API with Zapier webhook support. The API exposes 4 endpoints secured with apiKey authentication.

## For AI agents

Programmatically zapier_auth, sample_rest_hook_response. Covers 4 operations with apiKey authentication.

## Scope

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

## Capabilities

- zapier_auth
- sample_rest_hook_response
- rest_hooks_subscribe
- rest_hooks_unsubscribe
- Monitor Surventrix API operational status and events

## Use cases

### CRM Operations

Use the Surventrix API to perform crm operations programmatically. The API provides 4 endpoints covering core functionality including zapier_auth, sample_rest_hook_response, rest_hooks_subscribe.

Example prompt: Call GET `/api/zapier_auth` to zapier_auth

### Automated Zapier Integration Management

Automate zapier integration operations by combining multiple Surventrix API endpoints. Agents can sample_rest_hook_response and then rest_hooks_subscribe in a single workflow.

Example prompt: Call GET `/api/sample_rest_hook_response` to sample_rest_hook_response, then verify the result

### AI Agent Integration via Jentic

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

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/api/zapier_auth` | zapier_auth |
| GET | `/api/sample_rest_hook_response` | sample_rest_hook_response |
| POST | `/api/rest_hooks_subscribe` | rest_hooks_subscribe |
| PATCH | `/api/rest_hooks_unsubscribe` | rest_hooks_unsubscribe |

## Key resources

- **Zapier Integration** — Zapier webhook and trigger integration endpoints

## Why Jentic

- **Setup:** Wiring the Surventrix API by hand means passing its API key in the Authorization header, setting up the REST hook subscriptions, and managing retries yourself against 2.surventrix.com. Through Jentic you install once, import the Surventrix API from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** The Surventrix operations here take their targets in the request body rather than as URL path ids, so scope the agent to the operations it needs, such as reading the sample hook response or subscribing to a REST hook. Unsubscribing is only in reach if you include it in the allowed set.
- **Credential handling:** Your Surventrix 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 'subscribe to a REST hook' or 'authenticate the connection', and Jentic returns the matching Surventrix API 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 Surventrix API use?

The Surventrix 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 zapier_auth with the Surventrix API?

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

### What are the rate limits for the Surventrix 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 zapier_auth through Jentic?

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

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

The Surventrix API exposes 4 endpoints covering zapier integration operations.

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

Yes. Because Jentic One runs self-hosted, your own rules decide which Surventrix operations and credentials the agent may use, so you grant only what a given task needs. For example, you can allow the agent to authenticate the connection, read the sample REST hook response, and subscribe to a REST hook, while withholding the unsubscribe operation unless you explicitly add it to the allowed set. Since these operations take their targets in the request body rather than as URL path ids, scoping is done at the operation level for each call the agent makes.