API keys & webhooks
Organization API keys allow outside systems to talk to CXGear without a human session.
Create a key
Section titled “Create a key”- Open API keys from the user menu.
- Generate a key.
- Copy the secret immediately — it is shown once.
- Store it in your middleware secrets manager.
Keys can include scopes such as ingest (add rows) and trigger (start a published spinner).
Screenshot needed
API keys page with generate action and a key row (prefix only).
Where: User menu → API keys
Save as:
src/assets/screenshots/29-api-keys.pngCommon patterns
Section titled “Common patterns”| Goal | Approach |
|---|---|
| CRM creates a lead | Ingest webhook or API ingest into a data table |
| CRM event should start outreach | Trigger the published spinner |
| Nightly batch | Prefer spinner schedule instead of external cron when possible |
Security
Section titled “Security”- Treat keys like passwords.
- Revoke unused keys.
- Use HTTPS only.
- Keys count against plan limits.