Skip to main content

Authentication

Every request to the Hookline API needs an API key in the Authorization header.

Authorization: Bearer hl_live_replace_me

Key types​

PrefixModeBehavior
hl_test_TestDelivers events to the CLI listener only
hl_live_LiveDelivers events to real endpoints

Create and rotate keys​

  1. Open the dashboard and select Settings, then API keys.
  2. Select Create key and choose a mode.
  3. Copy the key. Hookline shows it once.

To rotate a key, create a new one, deploy it, and then revoke the old key. Both keys work until you revoke the old one.

warning

Never commit API keys to source control or expose them in browser code. Store them in environment variables or a secrets manager.

Error responses​

A missing or invalid key returns a 401 response:

{
  "error": {
    "code": "invalid_api_key",
    "message": "The API key is missing or invalid."
  }
}

A valid key without access to the resource returns 403.