Skip to main content
Welcome to the Zenzap External Integration API documentation. This API is used to integrate with Zenzap. As a context we would like to familiarize you with the Zenzap platform and how it works. Zenzap is a platform for creating and managing topics and messages.
  • Topics (Zenzap term for group chats/channels/conversations) are used to create and manage conversations with your team. Topics are used to group messages and tasks together.
  • Messages are used to send and receive messages with your team.
  • Tasks are used to create and manage tasks with your team.
  • Members are used to manage your team members.
  • API keys are used to authenticate your requests to the Zenzap API. API keys are created and managed by the Zenzap admin user.
When you create a new API key, it would create a new bot user in Zenzap, on which behalf you can send messages, create topics, create tasks and manage members. All actions you perform with the API key will be performed on behalf of the bot user. The bot can be used within the scope of your organization. You can create topics, send messages, create tasks and manage members on behalf of the bot. Each bot picks a credential type at creation:
  • Static API key — long-lived key signed with HMAC-SHA256 on every request.
  • OAuth 2.0 client credentials — short-lived bearer tokens minted from clientId + clientSecret.
Either credential type works against the same /v2/* endpoints — see Authentication for both flows side by side.