Managing API Keys

Access the Helplane API for custom integrations.

What are API Keys?

API keys let you connect external applications to Helplane programmatically:

• Build custom integrations
• Automate workflows
• Sync data with other systems
• Create custom dashboards

Creating an API Key

• Go to Settings in the left sidebar
• Select API under Account
• Click Create API Key
• Enter a descriptive name (e.g., "Production Server")
• Click Create
• Copy the key immediately - it won't be shown again

API Key Security

• Keys are shown only once when created
• Store keys securely (environment variables, secret managers)
• Never commit keys to version control
• Use different keys for development and production

Viewing Your Keys

The API keys list shows:

• Key name
• Key prefix (partial key for identification)
• Creation date
• Last used date
• Status

Revoking Keys

To revoke an API key:

• Go to Settings > API
• Find the key in the list
• Click Delete
• Confirm deletion

Revoked keys stop working immediately. Applications using them will lose access.

Using Your API Key

Include your API key in the X-API-Key header when making requests:

curl -X GET "https://api.helplane.io/v1/conversations" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

Common API Endpoints

Rate Limits

API requests are rate limited to ensure fair usage:

• Standard: 100 requests per minute
• Burst: Up to 200 requests in short bursts

If you exceed limits, you'll receive a 429 Too Many Requests response.

API Documentation

For full API documentation, visit the Helplane API Reference.

Availability

Available on: Growth plan and above