API Reference

Hookbase provides a RESTful API for managing all aspects of your webhook infrastructure.

Interactive API Explorer

Try out endpoints directly from your browser with the API Explorer. Browse schemas, view examples, and send test requests — no setup required.

Postman Collection

Download the Postman Collection for quick API exploration.

OpenAPI Specification

Download the OpenAPI 3.0 Spec for SDK generation, API testing tools, and automated documentation.

Compatible with tools like Swagger UI, Redocly, and any OpenAPI code generator.

Base URL

https://api.hookbase.app

Authentication

All API requests require authentication. See Authentication for details.

URL Patterns

Hookbase supports two URL patterns for API requests:

API Key Authentication (Recommended)

When using an API key, the organization is inferred automatically from the key — no need to include an organization ID in the URL:

curl https://api.hookbase.app/api/sources \
  -H "Authorization: Bearer whr_your_api_key"

JWT Authentication

When using JWT tokens (e.g. from the dashboard), you must include the organization ID in the path:

curl https://api.hookbase.app/api/organizations/{orgId}/sources \
  -H "Authorization: Bearer your_jwt_token"

Request Format

• All requests should use Content-Type: application/json
• Request bodies should be JSON-encoded
• URL parameters should be URL-encoded

Response Format

All responses are JSON-encoded with the following structure:

Success Response

{
  "id": "src_abc123",
  "name": "My Source",
  "createdAt": "2024-01-15T10:30:00Z"
}

Or for lists:

{
  "data": [...],
  "pagination": {
    "total": 100,
    "page": 1,
    "pageSize": 20
  }
}

Error Response

{
  "error": "Not found",
  "message": "Source with ID src_xyz not found",
  "code": "RESOURCE_NOT_FOUND"
}

HTTP Status Codes

Rate Limits

Rate limits vary by plan:

Rate limit headers are included in every response:

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1705312800

Pagination

List endpoints support pagination:

GET /api/sources?page=1&pageSize=20

Filtering

Many list endpoints support filtering:

GET /api/events?status=delivered&sourceId=src_abc

Sorting

Sort results using the sort parameter:

GET /api/events?sort=-createdAt

Prefix with - for descending order.

API Endpoints

Core Resources

Webhook Ingest

Authentication & Access

Development Tools

Advanced Features

SDKs

Official SDKs are available for:

• JavaScript/TypeScript: npm install @webhookrelay/sdk
• Python: pip install webhookrelay
• Go: go get github.com/webhookrelay/go-sdk

Quick Examples

Create a Source

curl -X POST https://api.hookbase.app/api/sources \
  -H "Authorization: Bearer whr_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"name": "GitHub", "slug": "github"}'

List Events

curl https://api.hookbase.app/api/events \
  -H "Authorization: Bearer whr_your_api_key"

Replay an Event

curl -X POST https://api.hookbase.app/api/events/{eventId}/replay \
  -H "Authorization: Bearer whr_your_api_key"