Skip to main content

Overview

Welcome to the Zipteams documentation. This guide provides comprehensive information about the APIs and other components available for partners to integrate with the Zipteams platform.

Getting Started​

To get started with the Zipteams API, you'll need to:

  1. Register as a partner to receive your API credentials
  2. Review the documentation for the integration you need:
    • Customer API — if you are a Zipteams customer pushing your own call data into Zipteams
    • Partner API — if you are a partner integrating on behalf of multiple tenants
  3. Implement the integration using our APIs

Key Terminology​

Before diving into the technical details, it's important to understand the following key terms used throughout this documentation:

  • Tenant: A unique customer or organization that partners integrate with the Zipteams platform. Each tenant represents a distinct client entity in your system.
  • Subtenant: A unique group, department, or team within a tenant. Subtenants allow for more granular organization and data segregation within a tenant's structure.

Available APIs​

Zipteams offers the following APIs:

  • Customer APIs - Push your call recordings and customer status updates into Zipteams, and receive AI analysis back on your own webhooks
  • Partner APIs - APIs for partners to integrate with Zipteams

Embeddable Dashboards​

Zipteams offers the following dashboard that can be embedded in your application interface:

  • Customer Insights - Provides AI-powered analytics and insights based on your data
  • Customer Details - Provides an embeddable Customer Details page that offers a comprehensive view of individual customer interactions and AI-powered analysis. This feature-rich page visualizes critical customer information.

Support​

If you need assistance with the Zipteams API, please contact our support team at support@zipteams.com.