REST API Overview
The Hooklistener REST API provides programmatic access to all platform features. Create and manage debug endpoints, query captured requests, configure uptime monitors, and manage your organization.
Base URL
https://app.hooklistener.com/api/v1
Authentication
All API requests require authentication via an API key in the Authorization header:
Authorization: Bearer hklst_your_api_key
API keys are created from Organization Settings > API Keys in the dashboard. See Authentication for details.
Request format
- Content-Type:
application/jsonfor request bodies - Accept:
application/jsonfor responses
Response format
All responses return JSON. Successful responses typically wrap data in a data key:
{
"data": {
"id": "abc123",
"name": "My Endpoint"
}
}
List responses include pagination metadata:
{
"data": [...],
"page": 1,
"page_size": 20,
"total": 42
}
Error handling
Errors return appropriate HTTP status codes with a JSON error body. See Errors for details.
Rate limiting
API requests are subject to rate limiting. If you exceed the limit, you'll receive a 429 Too Many Requests response.
API sections
| Section | Description |
|---|---|
| Endpoints | CRUD debug endpoints |
| Requests | List, get, and delete captured requests |
| Request Forwarding | Forward and replay requests |
| Request Sharing | Share requests with shareable links |
| Anonymous Endpoints | Temporary no-auth endpoints |
| Uptime Monitors | CRUD uptime monitors |
| Status Pages | CRUD status pages |
| Organizations | Organization management |
| API Keys | API key management |
| Members | Organization member management |
| Signing Secrets | HMAC signing secret management |
| Secrets | Encrypted key-value storage |
| Static Tunnels | Reserved tunnel slug management |
| Subscriptions | Subscription management |