API overview
HookNexus exposes a business API at:
https://api.hooknexus.com
Typical uses covered in this reference:
- Incoming webhooks — third parties send HTTP requests to your endpoint URL (
/h/:endpointId). No API key is required to receive traffic on that public URL. - Live stream — your scripts or services connect with an API key over WebSocket to receive the same events in real time. See API keys and WebSocket.
Account, billing, and day-to-day setup are done in the web app at hooknexus.com.
Request and response format
Where JSON is used, bodies and responses are UTF-8 and usually Content-Type: application/json.
Rate limits
Limits depend on your subscription (for example daily webhook volume, payload size, and concurrent WebSocket connections). When a limit applies, you may see 429 Too Many Requests or an error object with a short message.
HTTP status codes (common)
| Status | Meaning |
|---|---|
| 200 | Success |
| 201 | Created |
| 400 | Bad request (validation, bad JSON, etc.) |
| 401 | Not allowed (for example invalid or missing API key where required) |
| 403 | Forbidden (plan, ownership, or feature gate) |
| 404 | Not found |
| 413 | Payload too large |
| 429 | Rate or quota exceeded |
| 500 | Server error |