canonical: https://jentic.com/apis/api.deepbot.gozen.io/gozen-deepbot

# Deepbot Gozen GoZen DeepAgent API

Jentic publishes the only available OpenAPI specification for GoZen DeepAgent API, keeping it validated and agent-ready. GoZen DeepAgent (DeepBot) lets businesses build a custom GPT-style chatbot, embed it on a website, and use it for customer support, lead generation, and user engagement. The Zapier-facing API exposed here is small but pivotal: it returns the authenticated user profile and lets external systems register and unregister webhooks so DeepBot conversations can fan out to CRMs, helpdesks, and notification channels. Authentication is via a single api-key header issued from the DeepBot dashboard.

## For AI agents

Register and unregister webhooks for the GoZen DeepBot chatbot and read the authenticated user profile. API-key authenticated.

## Scope

Does not handle bot training, conversation transcripts, or end-user messaging - use for webhook registration and api-key validation against the GoZen Zapier surface only.

## Capabilities

- Register an outbound webhook so DeepBot conversation events reach external systems via `/integration/zapierapp/webhook`
- Unregister a webhook to stop receiving DeepBot events without rotating the API key
- Read the authenticated user profile via `/integration/zapierapp/auth` for connection-test handshakes
- Wire DeepBot conversations into Zapier or any webhook consumer
- Verify an API key is valid before kicking off a longer integration flow

## Use cases

### Webhook-Based Chatbot Integration

Forward DeepBot chatbot events to a CRM, helpdesk, or notification channel by registering a webhook through POST `/integration/zapierapp/webhook.` The receiving URL gets called with the conversation payload each time DeepBot fires an event. When the integration is retired or the URL changes, DELETE `/integration/zapierapp/webhook` removes it without affecting the api-key. This is the canonical way to fan out chatbot data without polling.

Example prompt: POST `/integration/zapierapp/webhook` with target URL https://hooks.example.com/deepbot to register a webhook, then verify the registration via GET `/integration/zapierapp/auth`

### API-Key Validation and Connection Test

GET `/integration/zapierapp/auth` returns the user profile associated with the supplied api-key. Integration platforms call this on connection setup to validate the key and surface the connected account name to the user. It is also the cheapest call you can make to confirm the key is still valid before running a longer workflow.

Example prompt: Call GET `/integration/zapierapp/auth` and confirm the api-key resolves to a user profile before triggering a webhook registration

### Lead Capture from Chatbot to CRM

When DeepBot collects a lead during a conversation, the registered webhook fires and the receiving system creates a CRM contact. Pair POST `/integration/zapierapp/webhook` with a CRM-side webhook receiver to convert chatbot conversations into qualified leads in seconds rather than batched exports. Particularly useful for SaaS sites that want every chatbot lead in HubSpot or Salesforce immediately.

Example prompt: Register a webhook pointing to the CRM intake endpoint and confirm a test conversation creates a contact downstream

### AI Agent Connector Setup

An AI agent uses GoZen DeepAgent through Jentic to set up its own webhook so DeepBot conversations stream into the agent's downstream tooling. The agent searches Jentic by intent, loads the schema, and registers the webhook with the agent-supplied callback URL. Jentic injects the api-key from the vault so the agent never holds the credential.

Example prompt: Search Jentic for 'register a DeepBot webhook', load the schema, and register a callback URL the agent owns

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/integration/zapierapp/auth` | Get the user profile for the supplied api-key |
| POST | `/integration/zapierapp/webhook` | Register a webhook for DeepBot events |
| DELETE | `/integration/zapierapp/webhook` | Unregister a webhook |

## Key resources

- **Auth** — Validate api-keys and read the authenticated user profile
- **Webhooks** — Register and unregister webhooks for DeepBot conversation events

## Why Jentic

- **Setup:** Wiring the GoZen DeepAgent API by hand means handling its api-key auth and mapping the Zapier auth, webhook registration, and deregistration routes yourself. Through Jentic you install once, import GoZen DeepAgent from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** GoZen DeepAgent addresses work through the request body rather than resource ids in the URL path, so you limit the agent to the operations it needs, such as validating the api-key or registering a webhook. Webhook deregistration is a separate operation that is only available if you include it in the allowed set.
- **Credential handling:** Your GoZen DeepAgent 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 'register a DeepBot webhook', and Jentic returns the matching operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Drift API** — Drift offers a chatbot platform with native conversation, contact, and lead APIs that go beyond DeepBot's Zapier surface.
- **ChatBot.com API** — ChatBot.com is a comparable chatbot builder with broader API coverage for stories, intents, and conversations.
- **HubSpot Account Info API** — HubSpot is a typical destination for chatbot leads captured by DeepBot via webhook.

## FAQ

### Why is there no official OpenAPI spec for GoZen DeepAgent API?

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

GoZen DeepAgent uses an `api-key` header issued from the DeepBot dashboard. Every request must include `api-key: <your key>`. Jentic stores the key encrypted in the vault so agents never see it; the header is injected at execution time.

### Can I register a webhook with the GoZen DeepAgent API?

Yes - POST `/integration/zapierapp/webhook` registers an outbound webhook URL that DeepBot calls when conversation events occur. DELETE `/integration/zapierapp/webhook` removes the registration. This is the primary mechanism for streaming chatbot conversations into a CRM, helpdesk, or any other system.

### What are the rate limits for the GoZen DeepAgent API?

GoZen does not publish fixed rate limits for this Zapier-facing surface. The endpoints are infrequent by design - you call `/integration/zapierapp/auth` on connection setup and `/integration/zapierapp/webhook` to register or unregister. If you need to rotate webhooks at scale, throttle the calls and back off on any 429 response.

### How do I wire DeepBot into a CRM through Jentic?

Run `pip install jentic`, search for 'register a DeepBot webhook', load the POST `/integration/zapierapp/webhook` schema, and execute with the CRM's intake URL. Jentic injects the api-key automatically. Then use a separate Jentic call to your CRM (for example HubSpot) so the inbound webhook payload becomes a CRM contact.

### Can I have multiple webhooks registered at once?

The Zapier-facing surface is designed for a single webhook URL per connected app. To fan out events to multiple destinations, register a single webhook on a relay that you own (for example a small serverless function) and have the relay multicast events. This is the typical pattern when piping DeepBot into both a CRM and a chat notification channel.

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

Yes. Because you run Jentic One yourself, your own rules decide which of the GoZen DeepAgent operations the agent may call, so you can allow it to only validate the api-key via GET `/integration/zapierapp/auth` or register a webhook via POST `/integration/zapierapp/webhook.` Webhook deregistration through DELETE `/integration/zapierapp/webhook` is a separate operation that the agent can run only if you include it in the allowed set. Since GoZen addresses work through the request body rather than resource ids in the URL, you scope the agent at the operation level to just the calls it needs.