Enterprise API
UI: Enterprise API
Deep link: ?settings=workplace§ion=enterprise-api
Audience: Workplace admins / integrators
What it's for
Manage API keys, webhooks, rate limits, and the event catalog for machine-to-machine integrations.
Relevance
Single surface for keys/secrets (shown once). Without this, external integrations cannot authenticate or receive events.
Example of use
Admin Create API key, copies the secret, Create webhook with Endpoint URL + events, tests Test ping, reviews Deliveries.
Who can use it
Workplace admins with Enterprise API.
Screen Anatomy
Tabs: API Keys · Rate Limits · Webhooks · Event Catalog.
Alert Store secrets securely.
Options and fields
API Keys
| Control | Function |
|---|---|
| Create API key | Name · Expires in (incl. Never) |
| Active / Revoked | Status |
| Rotate · Revoke | Lifecycle |
| Confirm revoke | Key stops immediately |
Webhooks
| Control | Function |
|---|---|
| Create webhook | Name · Endpoint URL · events |
| Edit · Disable · Rotate secret · Test ping · Deliveries | Management |
| Copy secret / Shown once / Close | One-time secret |
| Recent deliveries | Delivery history |
| Subscription presets · event catalog picker | Events |
| Delivery · Deduplication key · HMAC rotation overlap | Advanced options |
Event Catalog / Rate Limits
| Control | Function |
|---|---|
| Search events | Filter catalog |
| Retry | Reload on error |
| Rate limits: Default limit · Max delivery attempts · Retry policy · Enforcement notes · Filter | Limits catalog |
How to use
- Workplace Settings → Enterprise API.
- Create key → copy secret immediately.
- Create HTTPS webhook → select events → Test ping.
Links
Tips / Common Errors
- Secrets will not be shown again after closing the dialog.
- Endpoint must be HTTPS.
Was this article helpful?