Skip to main content

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/json for request bodies
  • Accept: application/json for 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

SectionDescription
EndpointsCRUD debug endpoints
RequestsList, get, and delete captured requests
Request ForwardingForward and replay requests
Request SharingShare requests with shareable links
Anonymous EndpointsTemporary no-auth endpoints
Uptime MonitorsCRUD uptime monitors
Status PagesCRUD status pages
OrganizationsOrganization management
API KeysAPI key management
MembersOrganization member management
Signing SecretsHMAC signing secret management
SecretsEncrypted key-value storage
Static TunnelsReserved tunnel slug management
SubscriptionsSubscription management