Custom API Integration

Connect your NeuralTalk AI chatbot to any custom API or webhook, enabling powerful integrations with your existing systems and creating tailored automation workflows. Custom API Integration Overview

Overview

The Custom API integration enables your NeuralTalk AI chatbot to:

🔗 Connect to any REST API or webhook
⚡ Send data to external systems in real-time
📊 Receive data from external systems
🎯 Create custom automation workflows
🔄 Bidirectional data synchronization
💼 Integrate with proprietary systems

Benefits of Custom API Integration

✅ Unlimited Flexibility: Connect to any system with an API
⚡ Real-time Integration: Instant data synchronization
🎯 Custom Workflows: Build tailored automation for your needs
🔄 Bidirectional Sync: Send and receive data both ways
💰 Cost Effective: Leverage existing API infrastructure
🚀 Scalable: Handle high-volume data processing

You’ll need API credentials and endpoints for the systems you want to integrate with your chatbot.

Prerequisites

Before setting up your Custom API integration, you need:

✅ An active NeuralTalk AI account
🤖 A created and trained chatbot on the NeuralTalk AI platform
🔗 API credentials for your target system
📡 API endpoints and documentation
🔑 Appropriate permissions for the target API

Setup Process

Step 1: Prepare Your API

Identify API Endpoints: Determine which endpoints you need to integrate
Get API Credentials: Obtain API keys, tokens, or authentication credentials
Review API Documentation: Understand the API structure and requirements
Test API Access: Verify you can make successful API calls

Step 2: Configure NeuralTalk AI Integration

Log in to your NeuralTalk AI dashboard
Select the chatbot you want to connect to your custom API
Navigate to Settings > Chatbot Settings > Integrations
Find the Custom API Integration card
Click “Connect” to start the configuration process

Step 3: Set Up API Configuration

API Base URL: Enter the base URL of your API
Authentication: Configure authentication method (API key, OAuth, etc.)
Headers: Set up required headers for API calls
Endpoints: Configure specific endpoints for different actions

Step 4: Configure Data Mapping

Outbound Data: Map chatbot data to API request format
Inbound Data: Map API response data to chatbot format
Field Mapping: Configure field mappings between systems
Data Transformation: Set up data transformation rules

Step 5: Test and Activate

Test Connection: Verify API connection is working
Test Data Flow: Test sending and receiving data
Validate Responses: Ensure data is processed correctly
Activate Integration: Turn on the integration

How It Works

Once connected, your NeuralTalk AI-Custom API integration will:

📤 Outbound Data Flow

Event Detection: Monitor chatbot interactions for specific events
Data Collection: Gather relevant conversation and user data
Data Transformation: Convert data to API request format
API Call: Send data to your custom API endpoint

📥 Inbound Data Flow

API Response: Receive data from your custom API
Data Processing: Process and validate incoming data
Data Transformation: Convert data to chatbot format
Chatbot Update: Update chatbot with new data

🔄 Bidirectional Sync

Real-time Updates: Keep both systems synchronized
Conflict Resolution: Handle data conflicts between systems
Error Handling: Manage API errors and retries
Logging: Track all API interactions and results

Configuration Options

Authentication Methods

API Key Authentication:

{
  "type": "api_key",
  "key": "X-API-Key",
  "value": "your-api-key-here"
}

Bearer Token Authentication:

{
  "type": "bearer",
  "token": "your-bearer-token-here"
}

Basic Authentication:

{
  "type": "basic",
  "username": "your-username",
  "password": "your-password"
}

OAuth 2.0 Authentication:

{
  "type": "oauth2",
  "client_id": "your-client-id",
  "client_secret": "your-client-secret",
  "token_url": "https://api.example.com/oauth/token"
}

Data Mapping

Outbound Data Mapping:

{
  "conversation_id": "{{conversation.id}}",
  "user_email": "{{user.email}}",
  "message": "{{message.text}}",
  "timestamp": "{{message.timestamp}}",
  "intent": "{{message.intent}}"
}

Inbound Data Mapping:

{
  "user_id": "{{response.user_id}}",
  "status": "{{response.status}}",
  "data": "{{response.data}}",
  "updated_at": "{{response.updated_at}}"
}

API Endpoints

Configure Multiple Endpoints:

{
  "endpoints": {
    "create_user": {
      "method": "POST",
      "url": "/api/users",
      "headers": {
        "Content-Type": "application/json"
      }
    },
    "update_user": {
      "method": "PUT",
      "url": "/api/users/{{user_id}}",
      "headers": {
        "Content-Type": "application/json"
      }
    },
    "get_user": {
      "method": "GET",
      "url": "/api/users/{{user_id}}",
      "headers": {}
    }
  }
}

Usage Examples

Customer Management System

Create New Customer:

{
  "trigger": "new_customer_identified",
  "action": {
    "endpoint": "create_customer",
    "data": {
      "name": "{{user.name}}",
      "email": "{{user.email}}",
      "phone": "{{user.phone}}",
      "source": "chatbot",
      "conversation_id": "{{conversation.id}}"
    }
  }
}

Update Customer Status:

{
  "trigger": "conversation_ended",
  "action": {
    "endpoint": "update_customer_status",
    "data": {
      "customer_id": "{{user.customer_id}}",
      "status": "{{conversation.status}}",
      "last_interaction": "{{conversation.ended_at}}"
    }
  }
}

Order Management System

Create Order:

{
  "trigger": "order_placed",
  "action": {
    "endpoint": "create_order",
    "data": {
      "customer_id": "{{user.customer_id}}",
      "items": "{{order.items}}",
      "total": "{{order.total}}",
      "conversation_id": "{{conversation.id}}"
    }
  }
}

Update Order Status:

{
  "trigger": "order_status_changed",
  "action": {
    "endpoint": "update_order_status",
    "data": {
      "order_id": "{{order.id}}",
      "status": "{{order.status}}",
      "updated_at": "{{timestamp}}"
    }
  }
}

Support Ticket System

Create Support Ticket:

{
  "trigger": "support_requested",
  "action": {
    "endpoint": "create_ticket",
    "data": {
      "customer_id": "{{user.customer_id}}",
      "subject": "{{ticket.subject}}",
      "description": "{{ticket.description}}",
      "priority": "{{ticket.priority}}",
      "conversation_id": "{{conversation.id}}"
    }
  }
}

Update Ticket Status:

{
  "trigger": "ticket_resolved",
  "action": {
    "endpoint": "update_ticket_status",
    "data": {
      "ticket_id": "{{ticket.id}}",
      "status": "resolved",
      "resolved_at": "{{timestamp}}"
    }
  }
}

Advanced Configuration

Error Handling

Retry Logic:

{
  "retry": {
    "max_attempts": 3,
    "delay": 1000,
    "backoff": "exponential"
  }
}

Error Responses:

{
  "error_handling": {
    "on_failure": "log_and_continue",
    "fallback_action": "send_notification",
    "error_notification": {
      "email": "admin@company.com",
      "webhook": "https://hooks.slack.com/your-webhook"
    }
  }
}

Data Transformation

Transform Outbound Data:

{
  "transform": {
    "function": "function(data) { return { ...data, processed_at: new Date().toISOString() }; }"
  }
}

Transform Inbound Data:

{
  "transform": {
    "function": "function(response) { return { ...response, received_at: new Date().toISOString() }; }"
  }
}

Conditional Logic

Conditional API Calls:

{
  "conditions": [
    {
      "field": "user.type",
      "operator": "equals",
      "value": "premium",
      "action": "call_premium_api"
    },
    {
      "field": "user.type",
      "operator": "equals",
      "value": "basic",
      "action": "call_basic_api"
    }
  ]
}

Monitoring & Analytics