Hooksbase Docs
Hooksbase helps you receive inbound events, deliver them to your app, and operate the full lifecycle from one place. These docs cover the dashboard product, the project-authenticated Public API, and the public ingest endpoints that power real event delivery.
Overview
Most teams start in the Hooksbase dashboard, create a project, provision a webhook, and then move into the API or SDK once they want repeatable automation. Hooksbase keeps those surfaces aligned: the dashboard manages project state and guided setup, the Public API manages live webhook infrastructure, and the public ingest endpoints accept the events you send.
Choose your path
- Name
Dashboard users- Type
- no code
- Description
Start with the dashboard path. Create a project, follow onboarding, validate one webhook, inspect the first delivery, invite teammates, and manage billing without touching an API.
- Name
Developers- Type
- API / SDK
- Description
Start with the API and SDK path. Use public routes, the TypeScript SDK, webhook ingest, signature verification, errors, and pagination to build integrations.
- Name
Agents and LLMs- Type
- CLI
- Description
Start with the CLI and agent path. Use
hooksbase,--json, cursor-safe reads, idempotency keys, and a re-read-after-mutation loop.
Choose your surface
- Name
Dashboard- Type
- session auth
- Description
Use the Hooksbase dashboard for project creation, onboarding, team management, billing, delivery inspection, and other product workflows. The dashboard is the product surface — there are no public API routes for it.
- Name
Public API- Type
- project API key
- Description
Use the project-authenticated API for webhook configuration, delivery history, replay, usage, and operational automation. These requests use
Authorization: Bearer swk_....
- Name
Public ingest- Type
- webhook secret
- Description
Use public ingest to publish events into a webhook. These requests go to
/v1/ingest/{publicId}and authenticate withAuthorization: Bearer whsec_....
- Name
Public reference- Type
- customer-facing routes
- Description
Use the Public API reference to confirm route families, auth requirements, and SDK/CLI coverage. Browser-only dashboard workflows stay documented as product guides, not endpoints.
Start here
AI agents
Use the CLI as the stable control plane for coding agents, terminal automations, and scripted operator loops.
Dashboard overview
Use the UI for project setup, onboarding, delivery inspection, teams, and billing.
Public API reference
Confirm customer-facing routes, credentials, and first-party client coverage.
Projects and settings
Understand project boundaries, API keys, logo management, and destructive settings changes.
Team and invites
Invite teammates, manage roles, and understand invitation preview and accept flows.
Onboarding
Use workflow blueprints and guided validation to get to a working first flow faster.
Core workflows
Authentication
Choose the right credential for dashboard access, project APIs, ingest, and outbound verification.
Public API reference
Browse public route families, auth requirements, and SDK/CLI coverage without dashboard-only routes.
Webhooks
Create inbound endpoints, configure lifecycle controls, and understand delivery settings and tiers.
Ingest
Publish events over the public ingest endpoint with idempotency, scheduling, and content-type awareness.
Deliveries and replay
Inspect attempts, replay failed work, and understand how delivery history, DLQ, and files relate.
Limits and quotas
Check tier quotas, feature gates, file limits, replay windows, and retention behavior.