canonical: https://jentic.com/apis/webconnex.io/webconnex

# Webconnex API

Webconnex (used by RedPodium) provides APIs for managing orders, registrants, tickets, subscriptions, transactions, customers, forms, coupons, and webhooks. The API exposes 32 endpoints secured with apiKey authentication.

## For AI agents

Programmatically health check, search orders. Covers 32 operations with apiKey authentication.

## Scope

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

## Capabilities

- Health check
- Search orders
- Get order by ID
- Check in registrant
- Monitor Webconnex API operational status and events

## Use cases

### Payments Operations

Use the Webconnex API to perform payments operations programmatically. The API provides 32 endpoints covering core functionality including health check, search orders, get order by id.

Example prompt: Call GET /ping to health check

### Automated Coupons Management

Automate coupons operations by combining multiple Webconnex API endpoints. Agents can search orders and then get order by id in a single workflow.

Example prompt: Call GET `/search/orders` to search orders, then verify the result

### AI Agent Integration via Jentic

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

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/ping` | Health check |
| GET | `/search/orders` | Search orders |
| GET | `/search/orders/{id}` | Get order by ID |
| GET | `/search/registrants` | Search registrants |
| GET | `/search/registrants/{id}` | Get registrant by ID |
| POST | `/registrant/check-in` | Check in registrant |
| POST | `/registrant/check-out` | Check out registrant |
| GET | `/search/tickets` | Search tickets |

## Key resources

- **Coupons** — Operations related to Coupons
- **Customers** — Operations related to Customers
- **Forms** — Operations related to Forms
- **General** — Operations related to General
- **Orders** — Operations related to Orders

## Why Jentic

- **Setup:** Wiring the Webconnex API by hand means learning its API key header, pointing at api.webconnex.com, and handling responses yourself. Through Jentic you install once, import the Webconnex API from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** Webconnex puts the record id in the URL path (`/search/orders/{id}`, `/search/registrants/{id}`), so a rule can pin your agent to reading one order or registrant and nothing else. You choose the operations it may call, so state-changing ones like check-in or check-out are not included unless you add them.
- **Credential handling:** Your Webconnex 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 'search orders' or 'check in a registrant', and Jentic returns the matching Webconnex operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Stripe** — Alternative payments API
- **Adyen** — Alternative payments API
- **Square** — Complementary payments API
- **Paypal** — Complementary payments API

## FAQ

### What authentication does the Webconnex API use?

The Webconnex API uses an API key passed in the `apiKey` 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 health check with the Webconnex API?

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

### What are the rate limits for the Webconnex 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 health check through Jentic?

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

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

The Webconnex API exposes 32 endpoints covering coupons, customers, forms operations.

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

Yes. Because you run Jentic One yourself, your own rules decide which Webconnex operations and credentials the agent may use, and it can only call what you allow. Since Webconnex puts the record id in the URL path, such as `/search/orders/{id}` and `/search/registrants/{id}`, you can pin the agent to reading a single order or registrant and nothing else. State-changing operations like the check-in and check-out endpoints stay out of reach unless you explicitly add them.