API Keys
API Keys
Section titled “API Keys”Use API keys for programmatic access to DeskFork from your own systems, CI/CD pipelines, or third-party integrations.
Creating an API key
Section titled “Creating an API key”Go to Settings → Developers → API Keys → New API key.
| Field | Description |
|---|---|
| Name | Human-readable label (e.g. “Zapier integration”) |
| Scopes | Permissions granted (see below) |
| Expiry | Optional expiry date |
The key is shown once at creation time. Copy it immediately — DeskFork stores only the hash.
Key format
Section titled “Key format”ed_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxKeys are prefixed with ed_live_ (production) or ed_test_ (sandbox, coming Phase 2).
Scopes
Section titled “Scopes”| Scope | Allows |
|---|---|
tickets:read | List and read tickets |
tickets:write | Create, update, and close tickets |
messages:write | Add replies and internal notes |
contacts:read | Read contact records |
contacts:write | Create and update contacts |
kb:read | Read knowledge base articles |
kb:write | Create and publish KB articles |
admin:read | Read workspace settings |
Using the key
Section titled “Using the key”Authorization: Bearer ed_live_xxxxRevoking a key
Section titled “Revoking a key”Go to Settings → Developers → API Keys → [key] → Revoke. Revocation is immediate.