Skip to content
HookNexus

API keys

API keys let your servers, scripts, or tools subscribe to webhook traffic over WebSocket without using the browser dashboard.

Create a key in the web app

Keys are created and revoked only in the browser (not via this documentation).

  1. Sign in at hooknexus.com.
  2. Open Settings (or Account → API Keys, depending on the current UI).
  3. Choose Create API key (or similar).
  4. Optionally set a name so you can tell keys apart later.
  5. Copy the full key immediately — it is shown once. Store it in a password manager or secret store.

Security

  • Treat the key like a password: do not commit it to git, paste it into public sites, or ship it in front-end code.
  • If a key leaks, revoke it in the same Settings screen and create a new one.
  • Prefer environment variables or your platform’s secret manager (HOOKNEXUS_API_KEY, etc.).

Using your API key

The main documented use is the WebSocket live stream:

wss://api.hooknexus.com/ws/<endpointId>?apikey=<your_api_key>

Replace <endpointId> with the UUID of an endpoint that belongs to your account. Details, message shapes, and examples are in WebSocket.