Contacts & Chats APIs
This section contains the Leads and Chat API references
The Contacts & Chats APIs in BotPenguin allow developers and businesses to programmatically manage contacts, access chat conversations, and sync conversation data with external systems such as CRMs, analytics tools, or internal dashboards.
π What Are Contacts & Chats APIs?
These APIs provide secure access to:
Contact (visitor) details collected by bots
Chat conversations between users and bots/agents
Message history, metadata, and conversation status
They are commonly used for CRM integration, reporting, automation, and custom workflows.
π Key Capabilities
Contacts API
Use the Contacts API to:
Fetch all contacts created by bots
Retrieve contact details (name, email, phone, channel, tags)
Sync contacts with CRMs or databases
Identify leads generated through bots
Chats API
Use the Chats API to:
Fetch chat conversations
Access message history (bot + user messages)
Track chat status (Open / Closed)
Identify assigned agents and bots
Analyze conversation timelines
π§© Common Use Cases
Sync BotPenguin leads with CRM systems (HubSpot, Zoho, Salesforce)
Build custom analytics dashboards
Store chat transcripts for compliance or QA
Trigger workflows based on chat events
Monitor agent or bot performance externally
Last updated
Was this helpful?