APIs Overview
Welcome to the Pingstreams API documentation! Here you’ll find comprehensive guides for integrating Pingstreams into your applications using our REST APIs, Webhooks, Real-time APIs, and SDKs.
🔐 Authentication
Section titled “🔐 Authentication”Before using any Pingstreams API, you need to authenticate your requests.
- JWT Authentication - Learn how to generate and use JWT tokens for API authentication
🌐 REST APIs
Section titled “🌐 REST APIs”Full-featured REST API for managing all aspects of your Pingstreams account programmatically.
Core Resources
Section titled “Core Resources”- Introduction - Get started with REST APIs
- Authentication - API authentication methods
- Requests - Manage conversations and support requests
- Messages - Send and retrieve conversation messages
- Leads - Manage customer leads and contacts
Communication & Engagement
Section titled “Communication & Engagement”- Bots - Create and manage chatbots
- Canned Responses - Manage quick reply templates
- Events - Track and manage events
Organization & Workflow
Section titled “Organization & Workflow”- Projects - Manage projects and workspaces
- Team - Manage team members and permissions
- Labels - Organize conversations with labels
- Tags - Tag and categorize content
- Segments - Create customer segments
Analytics & Insights
Section titled “Analytics & Insights”- Analytics - Access analytics and reporting data
- Activities - Track user and system activities
Media & Resources
Section titled “Media & Resources”Advanced Features
Section titled “Advanced Features”- Knowledge Bases - Manage AI knowledge bases for smart responses
- Management API - Advanced management and configuration
⚡ Real-time APIs
Section titled “⚡ Real-time APIs”Get instant updates and enable real-time features in your applications.
- Real-time API - WebSocket API for real-time messaging and updates
- Conversation Messages API - Real-time conversation message handling
🔔 Webhooks
Section titled “🔔 Webhooks”Subscribe to events and get notified when important actions occur.
- Webhooks - Configure webhooks to receive real-time event notifications
📦 SDKs
Section titled “📦 SDKs”Official SDKs and libraries to accelerate your integration.
- NodeJS SDK - Official Node.js/JavaScript SDK for Pingstreams
📚 Tutorials
Section titled “📚 Tutorials”Step-by-step guides for common integration scenarios.
- REST API Tutorials - Learn by example with practical REST API tutorials
- Webhook Tutorials - Hands-on webhook implementation guides
🛠️ Additional Resources
Section titled “🛠️ Additional Resources”Developer Tools
Section titled “Developer Tools”- API Playground - Test API endpoints interactively (coming soon)
- Postman Collection - Import our complete API collection
- OpenAPI Specification - Download the OpenAPI/Swagger spec
Community & Support
Section titled “Community & Support”- Developer Forum - Connect with other developers
- GitHub Examples - Sample code and integrations
- Support - Get help from our team
Ready to start building? Choose an API above or check out our tutorials to see real-world examples!