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

# Networx Public API

Jentic publishes the only available OpenAPI specification for Networx Public API, keeping it validated and agent-ready. The Networx Public API exposes a small set of webhook-oriented endpoints for integrating with the Networx home services lead marketplace. It supports validating credentials, subscribing webhooks for incoming lead events, unsubscribing, and pulling example test data for development. The API is scoped specifically to lead delivery integrations rather than full CRM or marketplace management.

## For AI agents

Subscribe to Networx home-services lead webhooks and validate credentials so an agent receives new leads in real time without polling.

## Scope

Does not handle lead scoring, contractor billing, or marketplace bidding - use for webhook-based lead delivery integration only.

## Capabilities

- Subscribe a webhook URL to receive new home-services lead notifications from the Networx marketplace
- Unsubscribe an existing webhook subscription by its subscription identifier
- Validate Networx Basic Auth credentials before establishing a webhook subscription
- Pull example lead payload data through the test trigger endpoint to develop and verify webhook handlers
- Authenticate every request using HTTP Basic Auth with a Networx-issued username and password pair

## Use cases

### Real-Time Home Services Lead Routing

Contractors and lead-management platforms subscribe to Networx webhook events so new home-improvement leads are pushed into their CRM or dispatch system the moment a homeowner submits a request. The integration uses POST `/public/subscription` to register a callback URL secured with Basic Auth, eliminating polling and reducing speed-to-lead from minutes to seconds.

Example prompt: Call POST `/public/subscription` with the contractor's CRM webhook URL and Basic Auth credentials, then confirm receipt by triggering GET `/public/test_trigger` and verifying the test payload arrived.

### Integration Credential Validation

Before going live, integrators verify that the Basic Auth credentials issued by Networx are accepted using GET `/public/validate.` This catches misconfigured environment variables and rotated passwords during deployment rather than failing silently when real leads arrive.

Example prompt: Send GET `/public/validate` with the configured Basic Auth header and surface a clear error if the response status is not 200 so the deployment pipeline can block release.

### Sandbox Webhook Development

Developers building a new Networx integration call GET `/public/test_trigger` to receive a representative lead payload without waiting for real homeowner traffic. This lets them shape database schemas, build CRM mapping logic, and exercise error handling against realistic data before turning on the production subscription.

Example prompt: Invoke GET `/public/test_trigger`, parse the returned lead JSON, and seed a local database table so downstream CRM mapping logic can be unit tested.

### AI Agent Lead Distribution

An AI agent operating a contractor's intake workflow uses Jentic to discover the Networx subscribe operation, register a webhook tied to the agent's own ingestion endpoint, and then triage each incoming lead automatically - qualifying, scoring, and assigning to the correct technician without human intervention.

Example prompt: Use Jentic to search 'subscribe to home services leads', load the Networx subscribe schema, execute POST `/public/subscription` with the agent's ingestion URL, then route each subsequent webhook payload to the qualification workflow.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/public/validate` | Validate Basic Auth credentials |
| POST | `/public/subscription` | Subscribe a new webhook for lead events |
| DELETE | `/public/subscription/{subscription_id}` | Unsubscribe an existing webhook |
| GET | `/public/test_trigger` | Retrieve example lead data for testing |

## Key resources

- **Authentication** — Validate Basic Auth credentials before establishing integrations
- **Subscriptions** — Create and delete webhook subscriptions for receiving lead events
- **Testing** — Retrieve example lead payloads to develop and verify integrations

## Why Jentic

- **Setup:** Wiring the Networx Public API by hand means encoding its HTTP basic username and password, targeting the www.networx.com host, and managing lead-delivery webhook subscriptions yourself. Through Jentic you install once, import Networx from the API Directory, store the credentials once, and your agent calls it.
- **Permission scoping:** Networx puts the subscription id in the URL path (`/public/subscription/{subscription_id}`), so a rule can pin your agent to one subscription. You choose the operations it may call, so deleting a subscription is not included unless you add it.
- **Credential handling:** Your Networx basic auth username and password are stored once, encrypted, by your own Jentic One instance and injected at execution time as the basic auth header. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'subscribe to home services leads' or 'validate a subscription', and Jentic returns the matching Networx operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **HubSpot Marketing Events** — HubSpot CRM that consumes Networx leads downstream
- **Pipedrive API** — Sales CRM that can ingest Networx webhook lead payloads
- **Zapier Natural Language Actions** — Generic webhook router as an alternative to direct Networx integration

## FAQ

### Why is there no official OpenAPI spec for Networx Public API?

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

The Networx Public API uses HTTP Basic Auth - a username and password pair sent base64-encoded in the Authorization header. Through Jentic, these credentials are stored in the encrypted Jentic One instance and never enter the agent's context window.

### Can I subscribe to home-services leads with the Networx Public API?

Yes. Call POST `/public/subscription` with a callback URL and Networx pushes new lead payloads to that URL as homeowners submit requests. Use DELETE `/public/subscription/{subscription_id}` to remove the subscription when no longer needed.

### What are the rate limits for the Networx Public API?

Networx does not document explicit numeric rate limits in the spec. Because the API is webhook-driven rather than polled, normal usage involves only one subscribe call per integration plus occasional credential validation, so limits rarely apply.

### How do I test a Networx webhook integration through Jentic?

Use Jentic to search 'get networx test lead', load the GET `/public/test_trigger` schema, and execute it. The endpoint returns a representative lead payload you can use to develop and verify your webhook handler before subscribing in production.

### Is the Networx Public API free?

Access to the Networx Public API requires an active Networx contractor or partner account - credentials are issued by Networx as part of the commercial relationship, not self-served.

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

Yes. Jentic One is self-hosted, so you set the rules that decide which Networx operations and credentials your agent may use. You can allow only the calls you want, such as GET `/public/validate` and POST `/public/subscription`, while excluding DELETE `/public/subscription/{subscription_id}` so the agent cannot cancel a webhook. Because the subscription id sits in the URL path, a rule can also pin the agent to a single subscription rather than any it might name.