API Reference

Overview

WardiereAI is a fully managed service — we handle all API integrations, infrastructure, and maintenance for you. You never need to write code or manage API keys directly.

• All integrations are configured and maintained by the WardiereAI team during onboarding
• Your AI agent is connected using your own business accounts and credentials
• Enterprise customers get access to custom webhook endpoints for advanced integrations

WhatsApp Business API

WardiereAI connects through your own WhatsApp Business API account to receive and send messages on behalf of your AI agent.

How It Works

• Message receiving: Incoming customer messages trigger the N8N workflow, which routes them to your AI agent
• Message sending: AI-generated replies are sent back to the customer via the WhatsApp Business API
• Media support: Text messages, images, and documents are all supported

API Cost Responsibility

All WhatsApp Business API usage costs are borne entirely by the customer on actuals. This includes Meta's per-conversation fees, message template fees, phone number hosting charges, and any other charges from your Business Solution Provider (BSP). These costs are separate from and not included in your WardiereAI subscription. You are responsible for paying all WhatsApp Business API charges directly to Meta or your BSP.

Incoming Message Webhook Payload

When a customer sends a message on WhatsApp, the following payload is delivered to the workflow:

// Incoming WhatsApp message webhook payload
{
  "object": "whatsapp_business_account",
  "entry": [{
    "id": "WHATSAPP_BUSINESS_ACCOUNT_ID",
    "changes": [{
      "value": {
        "messaging_product": "whatsapp",
        "metadata": {
          "display_phone_number": "918088728030",
          "phone_number_id": "PHONE_NUMBER_ID"
        },
        "messages": [{
          "from": "919876543210",
          "id": "wamid.ABCdEfGhIjK...",
          "timestamp": "1700000000",
          "type": "text",
          "text": {
            "body": "Hi, I'd like to book an appointment."
          }
        }]
      },
      "field": "messages"
    }]
  }]
}

AI / LLM API Services

Your AI agent uses Large Language Model APIs for custom training, understanding customer queries, and generating intelligent responses.

Supported Providers

• Anthropic (Claude) — Advanced reasoning and conversational AI
• OpenAI (ChatGPT) — General-purpose language models (GPT-4, etc.)
• xAI (Grok) — Real-time knowledge and conversational AI
• Google (Gemini) — Multimodal AI capabilities
• Other providers may be used based on your specific requirements

How It Works

• Customer-owned API keys: You create and own the account with your chosen LLM provider. API credentials belong to your business.
• Query processing: When a customer sends a message, the AI agent sends the relevant context to the LLM API and receives a generated response.
• Custom training: Your agent is fine-tuned or prompt-engineered with your business knowledge, products, services, and tone.
• Data minimisation: Only the minimum data necessary for generating a response is sent to the LLM provider.

API Cost Responsibility

All AI/LLM API usage costs are borne entirely by the customer on actuals. This includes per-token fees, per-request fees, fine-tuning charges, embedding costs, and any other charges from the model provider. These costs are separate from and not included in your WardiereAI subscription. Costs vary based on the model selected and your usage volume. You are responsible for maintaining an active account, monitoring usage, and paying all charges directly to the provider.

Example: Chat Completion Request

// Example LLM API request (varies by provider)
{
  "model": "claude-sonnet-4-20250514",
  "max_tokens": 1024,
  "messages": [
    {
      "role": "system",
      "content": "You are a helpful assistant for [Business Name]..."
    },
    {
      "role": "user",
      "content": "I'd like to know about your pricing plans"
    }
  ]
}

Google Calendar API

WardiereAI uses the Google Calendar API to check your real-time availability and book appointments directly from WhatsApp conversations.

Scopes Required

• calendar.readonly — Read calendar events to check availability
• calendar.events — Create, update, and manage booking events

Operations

• List events: Retrieve upcoming events to determine available time slots
• Create event: Book a new appointment with customer details and meeting link
• Check free/busy: Query availability across one or more calendars

Booking Event Payload

When a customer books an appointment, the following event is created on your Google Calendar:

// Google Calendar booking event payload
{
  "summary": "Consultation - Priya Sharma",
  "description": "Booked via WardiereAI WhatsApp Agent.\nCustomer: Priya Sharma\nPhone: +91 98765 43210\nNotes: Interested in premium plan.",
  "start": {
    "dateTime": "2026-03-22T10:00:00+05:30",
    "timeZone": "Asia/Kolkata"
  },
  "end": {
    "dateTime": "2026-03-22T10:30:00+05:30",
    "timeZone": "Asia/Kolkata"
  },
  "attendees": [
    { "email": "[email protected]" },
    { "email": "[email protected]" }
  ],
  "conferenceData": {
    "createRequest": {
      "requestId": "wardiere-abc123",
      "conferenceSolutionKey": { "type": "hangoutsMeet" }
    }
  }
}

Google Meet API

When an appointment is booked through your WhatsApp AI agent, WardiereAI automatically generates a Google Meet link and attaches it to the calendar event.

• Automatic link generation: A unique Google Meet URL is created for every booked appointment
• Calendar integration: The Meet link is embedded directly in the Google Calendar event
• Confirmation delivery: The meeting link is sent to both the customer (via WhatsApp) and the business owner (via calendar invite and email)

N8N Webhook Endpoints

Enterprise customers can access custom N8N webhook endpoints to connect WardiereAI with external CRMs, ERPs, or any system that supports HTTP webhooks.

Use Cases

• Push new leads from WhatsApp conversations to your CRM (Salesforce, HubSpot, etc.)
• Trigger workflows in your ERP when appointments are booked
• Sync customer data with internal databases or tools
• Send notifications to Slack, Teams, or other platforms

Webhook URL Format

// Webhook endpoint format
POST https://n8n.wardiere.xyz/webhook/{your-unique-webhook-id}

Example Webhook Payload

The following payload is sent to your configured webhook endpoint when a new lead is captured:

// N8N webhook payload example (new lead)
{
  "event": "new_lead",
  "timestamp": "2026-03-20T14:30:00Z",
  "data": {
    "customer_name": "Priya Sharma",
    "phone": "+919876543210",
    "email": "[email protected]",
    "source": "whatsapp",
    "intent": "booking_inquiry",
    "conversation_summary": "Customer inquired about premium plan pricing and booked a consultation.",
    "appointment": {
      "date": "2026-03-22",
      "time": "10:00",
      "timezone": "Asia/Kolkata",
      "meet_link": "https://meet.google.com/abc-defg-hij"
    }
  }
}

Webhook Security

Data & Storage

WardiereAI stores and organizes all conversation data, leads, and appointment records so you always have access to your business data.

• Conversation logs: Full chat history stored securely in your dedicated database
• Google Sheets / Excel sync: Structured lead and appointment data synced to spreadsheets in real time
• Data export (Enterprise): Programmatic data export available via API on Enterprise plans

Data Export Response Format

Enterprise customers can retrieve conversation and lead data programmatically:

// GET /api/v1/export/leads?from=2026-03-01&to=2026-03-20
{
  "status": "success",
  "period": {
    "from": "2026-03-01",
    "to": "2026-03-20"
  },
  "total_leads": 47,
  "leads": [
    {
      "id": "lead_a1b2c3d4",
      "customer_name": "Priya Sharma",
      "phone": "+919876543210",
      "first_contact": "2026-03-15T09:22:00Z",
      "messages_exchanged": 12,
      "intent": "booking_inquiry",
      "status": "appointment_booked"
    }
  ]
}

Authentication & Security

Security is foundational to how WardiereAI operates. All integrations use your own business credentials, and we follow industry best practices for data protection.

Encryption Standards

• In transit: All data encrypted using TLS 1.3
• At rest: AES-256 encryption for stored data
• Credential isolation: Each customer's API credentials are stored in isolated, encrypted vaults
• Access control: Role-based access with audit logging on all operations

Incident Notification

Rate Limits & Quotas

Rate limits are determined by the underlying platform providers. WardiereAI monitors usage and will notify you if you approach any thresholds.