Developers
Connect internal tools safely with the Protodesk Platform API.
- Create and manage API keysChoose workspace API permissions, understand Help Center key expiry, and store or revoke keys securely.
- Connect an AI tool to Help Center authoringConfigure the local MCP adapter, use limited Help Center API scopes, and verify the workspace before submitting proposals.
- Subscribe to webhooks and troubleshoot deliverySet up a Platform API webhook receiver, verify signatures, test delivery, and handle retries, pauses, and subscription removal.
- Handle API errors, pagination, retries, and realtime eventsInterpret errors, follow cursors, retry supported writes carefully, respect rate limits, and reconnect to workspace event streams.
- Manage customers and identities through the APICreate and upsert customers, read and patch profiles, and link channel identities without confusing records or verification.
- Manage conversations and messages through the APICreate and manage conversations, read messages safely, and distinguish recorded API messages from channel delivery.
- Make your first supported API requestCreate a limited workspace key, verify its scopes and workspace with /v1/me, and safely make your first public API read.
- Read published Help Center content through the APIUse the read-only public API to find a live Help Center, list and search published articles, and retrieve a full article safely.
- Integrate Live Chat identity and messagingEmbed the website widget, distinguish anonymous and verified visitor identity, and handle scoped Chat messaging safely.