Skip to main content
Skip to main content

API Reference, Webhooks & Custom Tool Servers (MCP)

REST API access, signed webhooks, OpenAPI Custom Actions, and Model Context Protocol (MCP) Custom Tool Servers (up to 128 tools) for your AI teammates.

5 min readUpdated 2026-11-08

Overview

Teammates.ai provides a REST API, signed webhooks, OpenAPI Custom Actions, and Model Context Protocol (MCP) Custom Tool Servers (up to 128 tools per server) for programmatic control and extensibility across your AI teammates, conversations, contacts, and integrations. All REST endpoints use bearer token authentication and return JSON responses.

Authentication

All API requests require a bearer token in the Authorization header. Obtain tokens through the standard platform authentication flow or Organization Settings > API. Your base URL is your organization’s Dashboard URL followed by /api/v1/.

  1. 1

    Obtain an Access Token

    Sign in through the Dashboard authentication flow or generate an API token in Organization Settings > API.

  2. 2

    Include the Authorization Header

    Add the header to every API request: Authorization: Bearer {your_access_token}

  3. 3

    Handle Token Refresh

    Session tokens expire periodically. Use the platform refresh token endpoint to obtain a new access token without re-authenticating. The Dashboard SDK handles this automatically.

Webhooks

Teammates.ai sends and receives webhooks for real-time data sync. Inbound webhooks accept events from Freshdesk, Zendesk, Intercom (ticket events), and HubSpot (CRM events). Outbound webhooks deliver notifications to Slack and Microsoft Teams. All inbound webhooks are securely validated to prevent unauthorized access, and built-in deduplication prevents double-processing of events.

Important

Always validate inbound webhook signatures before processing. Reject any request that fails HMAC verification. Your organization-specific secret is available in Organization Settings > API.

Key API Endpoints

Below is a high-level overview of the available API categories. For full endpoint documentation including request/response schemas, contact support@teammates.ai.

CategoryEndpointsDescription
Agents/api/v1/agents/CRUD operations on AI teammates
Conversations/api/v1/chat/Chat sessions, message history
Interviews/api/v1/interviews/Interview scheduling, scoring
Campaigns/api/v1/campaigns/Sales campaign management
CRM/api/v1/crm/CRM integration hub, sync status
Integrations/api/v1/integrations/OAuth callbacks, connection status
Webhooks/api/v1/webhooks/Inbound webhook handlers

Rate Limits

API requests are rate-limited per organization to ensure platform stability. Standard rate limits apply to all plans. If you require higher throughput for high-volume integrations, contact support@teammates.ai to discuss Enterprise plan rate limit adjustments.

Frequently Asked Questions

Can I build custom integrations?
Yes. Use the REST API, signed webhooks, OpenAPI Custom Actions, or connect a remote Model Context Protocol (MCP) Custom Tool Server (supporting up to 128 tools per server) for deep custom extensibility.
Is there a Postman collection?
Contact support@teammates.ai for API documentation and Postman collections.
Do API calls consume credits?
API calls that trigger teammate actions (sending messages through Raya, initiating calls through Adam, starting interviews through Sara) consume credits. Read operations do not.

Related Guides

Ready to try Integrations?

Free launch for your first business or free onboarding for your existing business + 5 starter Credits, no credit card required.

Explore Integrations

Was this article helpful?

Raya
Adam

Still need a hand?

Ask us anything in any language. Raya (Support) and Adam (Sales) answer 24/7 across 54+ languages and 19 Arabic dialects.