01 / The existing evidence
No public API
There is no public API and no webhooks for Peak Chat today. Do not plan an integration that depends on them.
Mapping
- Mapping
- Example
- Arrival in the workspace
- Not checked
Peak Chat · For developers (planned)
API and webhooks for Peak Chat:
planned, not available.
A public API and webhooks for Peak Chat are planned, so conversations and their outcomes can flow into your own systems. They do not exist today. What is connected today are the inbox channels, through your workspace's own accounts.
See what is connected todayPlanned feature · example fields · no connection
Peak ChatThe eventYour systemThe fieldYour system · Example mapping
One mapping in detail
01 / Peak ChatEvent
02 / Fictional test valueconversation.closed
03 / Your system
eventA readable data path as an example. No transfer.
View all 4 mappings
| Peak Chat | Field in the webhook |
|---|---|
| Event | event |
| Conversation | conversation_id |
| Channel | channel |
| Time | occurred_at |
Example mapping
No transfer
No transfer
A public API and webhooks for Peak Chat are not available yet.
One concrete targetYour systemArrival in the workspaceNot checked yet
Understand fields. Keep the source.
Your systemArrival in the workspaceNot checked yetThe mapping shows where the data goes. Only a test in your workspace shows what actually arrives.
02 / How it should work
Event. Signature. Your system.
An interface should respect the same rights as every person in the workspace.
- 01 / Today
An event fires
For example: a conversation starts, is handed over or is closed.
What is connected?Gmail and OutlookSlack and TeamsWhatsApp Business - 02 / Planned
Sent signed
Webhooks should go out signed to an address your workspace approves.
What is missing?Public APIWebhooksSigned events - 03 / Limit
Used in your system
Your system processes the event. Peak stays the source of the conversation.
What always holds?Workspace rightsNo outside accessTraceable
Trust needs clarity
Planned means: not here yet.
Mapping02 / Your check
No date promised
We do not say here when the interface will come. We will name it once it is verifiably available.
- Account
- Not connected here
- Rights
- Roles in the workspace
03 / The clear limit
Rights as in the workspace
Later, too, a key should never be allowed more than the person it belongs to.
- Channels today
- API planned
- Webhooks planned
- Rights
The next step
Channels today. Your systems later.
See which connections Peak Chat already has today.
See what is connected today←Check in your workspace what actually arrived.
Frequently asked questions
Is there an API for Peak Chat?
No. A public API and webhooks are planned. Do not plan an integration that depends on them.
What is connected today?
Gmail, Outlook, Slack, Teams and WhatsApp Business through your workspace's accounts.
What rights should an API key have?
Planned: never more than the person the key belongs to.