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

# Inly Zapier API V1

Jentic publishes the only available OpenAPI specification for Inly Zapier API V1, keeping it validated and agent-ready. Inly is a small-business CRM and project workspace; the Zapier-facing API V1 exposes the integration surface used by automations to create and update clients and projects, fetch sample records for trigger configuration, and subscribe to webhook events. The 13 endpoints cover client and project create/update actions, profile and sample data reads (clients, projects, events, flows, contact form responses, payments), and webhook subscribe/unsubscribe.

## For AI agents

Create and update Inly clients and projects, fetch sample records for automations, and subscribe to webhook events for clients, projects, payments, and contact form responses.

## Scope

Does not handle invoicing, payment processing, or marketing campaigns directly - use for Inly client/project creation, updates, and webhook subscriptions only.

## Capabilities

- Create new clients in Inly with structured contact and company fields via POST `/zapier/actions/create_client`
- Create new projects under existing clients with POST `/zapier/actions/create_project`
- Update existing clients and projects with POST `/zapier/actions/update_client` and update_project
- Read sample clients, projects, events, flows, contact-form responses, and payments for automation configuration
- Subscribe and unsubscribe to webhook events with POST `/zapier/webhooks/subscribe` and unsubscribe
- Retrieve the authenticated business profile via GET `/zapier/profile`

## Use cases

### Lead-to-Client Automation

When a new lead arrives from a website form, ad campaign, or third-party tool, automatically create a matching client record in Inly. POST `/zapier/actions/create_client` accepts the contact and company fields and returns the new client ID. Saves manual data entry for solo operators and small agencies whose CRM lives in Inly.

Example prompt: POST `/zapier/actions/create_client` with name, email, phone, and company fields from a new website lead, then return the resulting client ID.

### Project Lifecycle Tracking via Webhooks

Subscribe to Inly webhook events so external systems are notified when projects, payments, or contact form responses are created or updated. POST `/zapier/webhooks/subscribe` registers the target URL and event type; POST `/zapier/webhooks/unsubscribe` removes it. Useful for keeping an external dashboard or accounting system in sync with Inly without polling.

Example prompt: Subscribe a webhook to the 'payment.created' event with target URL https://example.com/hooks/inly-payment via POST `/zapier/webhooks/subscribe.`

### Cross-Tool Sync of Clients and Projects

Keep client and project records consistent between Inly and adjacent tools (accounting, scheduling, support). POST `/zapier/actions/update_client` and update_project let an integration apply changes from another system back into Inly when the source of truth lives elsewhere. Sample endpoints provide reference records during automation setup.

Example prompt: POST `/zapier/actions/update_project` with project_id and a new status of 'completed' to reflect a closed project from an external scheduling tool.

### AI Agent for Solo Operators

An LLM agent acting as a virtual assistant for a freelancer or small agency uses Inly as its CRM tool - creating clients from inbound emails, opening projects when work is agreed, and updating records as conversations progress. Through Jentic, the agent searches by intent and executes against Inly without managing the API key directly.

Example prompt: Parse an incoming email from a prospect, then POST `/zapier/actions/create_client` with the extracted name, email, and company, followed by POST `/zapier/actions/create_project` for the discussed engagement.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/zapier/actions/create_client` | Create a new client |
| POST | `/zapier/actions/create_project` | Create a new project under a client |
| POST | `/zapier/actions/update_client` | Update an existing client |
| POST | `/zapier/actions/update_project` | Update an existing project |
| GET | `/zapier/profile` | Get the authenticated business profile |
| POST | `/zapier/webhooks/subscribe` | Subscribe to a webhook event |
| POST | `/zapier/webhooks/unsubscribe` | Unsubscribe from a webhook event |

## Key resources

- **Clients** — Create and update Inly client records
- **Projects** — Create and update projects attached to clients
- **Profile** — Read the business profile linked to the API key
- **Samples** — Reference records for clients, projects, events, flows, contact form responses, and payments
- **Webhooks** — Subscribe and unsubscribe webhook listeners for Inly events

## Why Jentic

- **Setup:** Wiring the Inly Zapier API by hand means passing your key in the X-API-KEY header on every call, choosing between the production and staging hosts, and mapping its action-style endpoints yourself. Through Jentic you install once, import the Inly Zapier API from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** Inly takes the client and project fields in the request body rather than the URL path, so limit the agent to the operations it needs, such as creating a client. You choose which operations are allowed, so updating projects or unsubscribing webhooks are not included unless you add them.
- **Credential handling:** Your Inly X-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 'create a client in Inly' or 'subscribe to a webhook', and Jentic returns the matching Inly operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **HubSpot Account API** — HubSpot is a comprehensive CRM and marketing platform aimed at growing teams.
- **Pipedrive API** — Pipedrive is a sales-pipeline-first CRM with a richer deal model than Inly.
- **Stripe API** — Stripe handles invoicing and payment collection that Inly's projects ultimately bill against.

## FAQ

### Why is there no official OpenAPI spec for Inly Zapier API V1?

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

The Inly Zapier API V1 uses an API key in the 'X-API-KEY' header on every request. Through Jentic, the key is stored encrypted in your Jentic One instance and injected at runtime so the agent never sees the raw value.

### Can I create projects under an existing client?

Yes. POST `/zapier/actions/create_project` accepts a client identifier alongside the project fields, so the new project is associated with the right client at creation time.

### What are the rate limits for the Inly Zapier API V1?

Rate limits are not encoded in the spec; they are enforced per API key on the Inly side. Contact Inly support via api.inly.com for the current per-minute and per-day limits applied to your account.

### How do I subscribe to Inly webhook events through Jentic?

Search Jentic for 'subscribe to an Inly webhook' to find POST `/zapier/webhooks/subscribe.` Load the schema, supply the event type and target URL, and execute. Use POST `/zapier/webhooks/unsubscribe` to remove the subscription. Get started with Jentic One, the self-hosted execution layer.

### Why are there 'samples' endpoints in the API?

The `/zapier/samples`/* endpoints return representative records for clients, projects, events, flows, contact-form responses, and payments. Zapier-style automation builders use them to render field pickers when configuring triggers; agents can use them to discover the shape of records before constructing real updates.

### Can I limit what my agent is allowed to do with the Inly Zapier API V1?

Yes. Because you run Jentic One yourself, your own rules decide which Inly operations and credentials the agent may use, so you can allow only what a task needs. For example, you can permit POST `/zapier/actions/create_client` while withholding update_client, update_project, or the webhook subscribe and unsubscribe operations. The Inly API takes client and project data in the request body rather than the URL path, so scoping happens at the operation level rather than by path pattern.