Getting Started
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.
On a Zenzap admin user, go to https://app.zenzap.co/console
Create a new API key with the needed permissions
Copy the API key and secret from the API key settings
For each request:
Add the Authorization header with your API key
Calculate the HMAC-SHA256 signature:
For POST/PUT/PATCH/DELETE: Sign the request body
For GET: Sign the full request URI (e.g.,
/v2/members?limit=10&offset=0)
Add the X-Signature header with the hex-encoded signature
Last updated