Open the developer portal

Workspace owners and admins can open Workspace Tools → Developer Platform. A developer app belongs to the current organization and cannot access another workspace.

Choose Create sandbox app to provision:

  • a non-secret client ID;
  • a reveal-once klx_test_ API key;
  • synthetic customer, order, and conversation data;
  • an isolated test installation;
  • explicit API scopes.

Copy the key immediately. klaxify stores only a one-way hash and cannot display it again.

Call the sandbox API

Send the key from a server or secure development environment:

curl https://app.klaxify.com/api/developer/v1/sandbox/resources \
  -H "Authorization: Bearer klx_test_..."

Use GET /api/developer/v1/integrations with the same Bearer key to read the current integration capability catalog before you design an app workflow.

Never put a secret key into browser JavaScript, a mobile app bundle, a public repository, or a support message.

Use a stable external_id when retrying sandbox events. Repeated IDs return the original event instead of creating duplicates.

Configure and verify webhooks

Add a public HTTPS endpoint in the app configuration and choose Send signed test. The delivery timeline shows its event ID, HTTP response, and status.

Verify X-Klaxify-Signature against the exact request body, reject timestamps older than five minutes, and return a 2xx response within eight seconds.

Rotate or revoke a key

Create a replacement key, update your secret manager, confirm traffic on the new prefix, and then revoke the old key. Revocation is immediate and does not affect the app's other credentials.

Request production review

Complete the app description, support email, redirect URLs, webhook endpoint, privacy policy, terms, distribution choice, and data-handling explanation. Public apps must pass klaxify review before a live key becomes available. Approval never installs the app into a customer workspace without that workspace's authorization.

Read the developer guide or open the interactive API reference for endpoint details.