API Reference
Every Webbu API endpoint, generated from the OpenAPI spec, plus the interactive explorer.
Base URL
https://webbu.dev/apiFor example, ingest is POST https://webbu.dev/api/v1/ingest/{projectId}/{bufferId}.
Interactive reference
The full reference, with request and response schemas, code samples and a "Try it" playground, is at webbu.dev/api/docs.
The OpenAPI 3.0 spec is at webbu.dev/api/openapi.json. Import it into Postman, Insomnia or Bruno, or generate a client from it.
Authentication
Send an API key in the X-API-Key header (or a Firebase ID token as Authorization: Bearer …):
curl -H "X-API-Key: wbk_your_key_here" https://webbu.dev/api/v1/admin/projectsIngest doesn't require authentication; an API key is optional. See API Keys & Authentication for roles.
Conventions
- Request and response bodies are JSON
- You choose the IDs of projects and buffers when you create them
- Resource timestamps (
createdAt,receivedAt, …) are Unix epoch milliseconds; API key timestamps are ISO 8601 strings - Errors have an
errorfield; see Error Codes
Endpoints
Generated from the same OpenAPI spec. Click a path to open it in the interactive reference.
Ingest
Open in API referenceWebhook ingestion endpoints
| Method | Path | Summary | Auth |
|---|---|---|---|
| POST | /v1/ingest/{projectId}/{bufferId} | Ingest a webhook payload | Optional |
Projects
Open in API referenceProject management
| Method | Path | Summary | Auth |
|---|---|---|---|
| GET | /v1/admin/projects | List projects | Required |
| POST | /v1/admin/projects | Create a project | Required |
| GET | /v1/admin/projects/{projectId} | Get a project | Required |
| PATCH | /v1/admin/projects/{projectId} | Update a project | Required |
| DELETE | /v1/admin/projects/{projectId} | Delete a project | Required |
Buffers
Open in API referenceBuffer configuration
| Method | Path | Summary | Auth |
|---|---|---|---|
| GET | /v1/admin/buffers | List buffers | Required |
| POST | /v1/admin/buffers | Create a buffer | Required |
| GET | /v1/admin/buffers/{bufferId} | Get a buffer | Required |
| PATCH | /v1/admin/buffers/{bufferId} | Update a buffer | Required |
| DELETE | /v1/admin/buffers/{bufferId} | Delete a buffer | Required |
| POST | /v1/admin/buffers/{bufferId}/clone | Clone a buffer | Required |
| POST | /v1/admin/buffers/{bufferId}/test | Test buffer delivery | Required |
Analytics
Open in API referenceMetrics and analytics
| Method | Path | Summary | Auth |
|---|---|---|---|
| GET | /v1/analytics/summary | Get dashboard summary stats | Required |
| GET | /v1/analytics/timeseries | Get analytics timeseries data | Required |
Dead letter queue management
| Method | Path | Summary | Auth |
|---|---|---|---|
| GET | /v1/dlq | List dead letter queue items | Required |
| GET | /v1/dlq/{dlqId} | Get DLQ item details | Required |
| DELETE | /v1/dlq/{dlqId} | Delete a DLQ item | Required |
| POST | /v1/dlq/{dlqId}/retry | Retry a DLQ item | Required |
API Keys
Open in API referenceAPI key management
| Method | Path | Summary | Auth |
|---|---|---|---|
| GET | /v1/admin/api-keys | List API keys | Required |
| POST | /v1/admin/api-keys | Create a new API key | Required |
| DELETE | /v1/admin/api-keys/{keyId} | Revoke an API key | Required |
Credits
Open in API referenceCredit and billing
| Method | Path | Summary | Auth |
|---|---|---|---|
| GET | /v1/admin/credit-packs | List credit packs | Required |
| GET | /v1/admin/credit-packs/{packId}/checkout-url | Get credit pack checkout URL | Required |
| GET | /v1/admin/credits | Get credit balance | Required |
| GET | /v1/admin/credits/transactions | Get credit transaction history | Required |
Payments
Open in API referenceSubscription and payment management
| Method | Path | Summary | Auth |
|---|---|---|---|
| GET | /v1/admin/plans | List available subscription plans | Required |
| GET | /v1/admin/subscription | Get current subscription | Required |
| DELETE | /v1/admin/subscription | Cancel subscription (graceful) | Required |
| DELETE | /v1/admin/subscription/immediate | Cancel subscription immediately | Required |
| GET | /v1/admin/invoices | List invoices | Required |
| GET | /v1/admin/invoices/{invoiceId} | Get invoice details | Required |
| GET | /v1/admin/subscription/checkout-url | Get checkout URL | Required |
Customers
Open in API referenceCustomer management
| Method | Path | Summary | Auth |
|---|---|---|---|
| POST | /v1/admin/customers | Create a customer | Required |
| GET | /v1/admin/customers/{customerId} | Get a customer | Required |
Health
Open in API referenceHealth check
| Method | Path | Summary | Auth |
|---|---|---|---|
| GET | /health | Health check | None |