> ## Documentation Index > Fetch the complete documentation index at: https://docs.hookie.ai/llms.txt > Use this file to discover all available pages before exploring further. # Ingest an event through the public webhook URL, overriding the dataset > Four-segment form of the public webhook URL. POST only (index.ts:190); other methods fall through to the SPA. The fourth segment overrides the webhook's configured dataset for this request only. ## OpenAPI ````yaml /openapi.json post /{workspace}/{project}/{webhook}/{dataset} openapi: 3.1.0 info: title: Hookie API version: 1.0.0 summary: Capture, route and deliver webhooks. description: >- Hookie exposes three HTTP surfaces. **Ingest + streaming** is the public plane. A path-form endpoint URL authenticates by its own high-entropy slug — there is no key, token or cookie — and an `ik_live_…` ingest key authenticates the `/v1/*` routes. Whenever the URL names a dataset the payload is stored whole into it; project mapping rules are evaluated on exactly one shape, `POST /v1/ingest/{ingest_key}` with no dataset segment. **The customer portal API** is a separate, token-authed surface for your end customers, scoped to one portal and one customer. **The admin API** drives the console. It accepts either a browser session or an OAuth bearer token from a connected coding agent — the same routes, the same validation, the same audit trail. An agent's authority is its user's workspace role narrowed to the scopes granted in the console. This document is generated from the request handlers and adversarially verified against them. contact: name: Hookie url: https://hookie.ai license: name: Proprietary url: https://hookie.ai/legal/terms servers: - url: https://app.hookie.ai description: Production - url: https://app.preview.hookie.ai description: Preview security: [] tags: - name: Ingest description: Send events to Hookie. - name: Streaming description: Tail events in real time over SSE or WebSocket. - name: Portal description: Token-authed surface for your end customers. - name: Projects description: Projects and their settings. - name: Routing description: Rules, endpoints, datasets and records. - name: Delivery description: Destinations, deliveries and replay. - name: Workflows description: Multi-step workflows, triggers and AI agents. - name: Observability description: Search, correlation, stats and the audit log. - name: Workspace description: Members, connected agents, SSO and billing. paths: /{workspace}/{project}/{webhook}/{dataset}: post: tags: - Ingest summary: Ingest an event through the public webhook URL, overriding the dataset description: >- Four-segment form of the public webhook URL. POST only (index.ts:190); other methods fall through to the SPA. The fourth segment overrides the webhook's configured dataset for this request only. operationId: ingestPathFormToDataset parameters: - name: workspace in: path required: true description: >- Workspace (tenant) slug; must not be a reserved root (api, admin, stripe, v1, assets, settings, favicon.ico, robots.txt, sitemap.xml, index.html, app.js, styles.css, export.js, portal, brand, trial-info, .well-known, mcp). schema: type: string - name: project in: path required: true description: Project slug within the workspace. schema: type: string - name: webhook in: path required: true description: Webhook slug — the credential. Only an enabled webhook matches. schema: type: string - name: dataset in: path required: true description: >- Dataset to store the record in, overriding the webhook's configured dataset for this request. No validation is performed; the name is used as given. schema: type: string - name: Idempotency-Key in: header required: false description: >- Optional. A repeat key short-circuits with 200 before quota is charged. schema: type: string requestBody: required: false description: >- Same parsing as the 3-segment form: urlencoded and multipart are flattened (repeats become arrays, file parts become {filename, type, size} with the bytes discarded); every other Content-Type is parsed as JSON; an empty body becomes {}; a non-object payload is wrapped as {"value": }. Over 1,000,000 bytes yields 413. content: application/json: schema: description: Any JSON value. application/x-www-form-urlencoded: schema: type: object additionalProperties: oneOf: - type: string - type: array items: type: string multipart/form-data: schema: type: object additionalProperties: oneOf: - type: string - type: array items: type: string - type: object required: - filename - type - size properties: filename: type: string type: type: string size: type: integer responses: '200': description: >- Idempotent replay — a submission with this Idempotency-Key already exists for the tenant. No quota is charged when the duplicate is detected up front; a request that loses the unique-index race has already been counted against the monthly quota. content: application/json: schema: type: object required: - submission_id - idempotent additionalProperties: false properties: submission_id: type: string idempotent: type: boolean enum: - true '201': description: >- Stored and identity-routed into {dataset}; 'routed' holds that dataset name. A swallowed routing error surfaces as routed: [] and records: 0. content: application/json: schema: type: object required: - submission_id - routed - records additionalProperties: false properties: submission_id: type: string routed: type: array items: type: string records: type: integer '400': description: >- error: 'Body must be valid JSON' or 'Body is not valid multipart/form-data'. content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: >- error: 'Source IP not allowed' — the client IP failed the webhook allowlist or the tenant allowlist. content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: >- error: 'Unknown endpoint' — unknown workspace/project slug or unknown/disabled webhook slug. content: application/json: schema: $ref: '#/components/schemas/Error' '413': description: 'error: ''Body exceeds 1000000 bytes''.' content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: >- Edge rate limit {error: 'Rate limit exceeded', retry_after: 10} or monthly quota {error: 'Monthly event quota exceeded', upgrade_url: '/settings/billing', retry_after: 3600}. No Retry-After header. content: application/json: schema: allOf: - $ref: '#/components/schemas/Error' - type: object properties: retry_after: type: integer upgrade_url: type: string format: uri '500': description: >- error: 'Could not store submission' — the submissions insert failed with no idempotency winner to fall back to. content: application/json: schema: $ref: '#/components/schemas/Error' security: [] components: schemas: Error: type: object required: - error properties: error: type: string description: Human-readable reason. retry_after: type: integer description: Seconds to wait. Present on 429. upgrade_url: type: string format: uri description: Present only on a monthly-quota 429. ````