HiBot Documentation

Complete guides and API references for integrating and using HiBot's WhatsApp CRM platform.

Introduction

Learn about HiBot's features, capabilities, and how it can transform your business communication.

What is HiBot?

HiBot is an official WhatsApp CRM platform that helps businesses automate, engage, and optimize customer communications using Meta's WhatsApp Business API. With HiBot, you can send bulk messages, build AI chatbots, manage customer interactions, and integrate with your existing systems.

Key Features

  • Official WhatsApp Business API integration
  • AI-powered chatbot builder with no coding required
  • Bulk messaging with personalization
  • Unified team inbox for customer support
  • Advanced CRM with customer segmentation
  • Multi-channel support (WhatsApp, Facebook, Instagram, RCS)
  • Secure and compliant with data protection regulations
  • Real-time analytics and reporting

Quick Start

Get up and running with HiBot in just a few minutes.

Step 1: Create an Account

Sign up for a HiBot account to get started. You can begin with a free trial that includes all features.

Shell
# Visit the registration page
https://dash.hibot.live/register

# Fill in your business details
# Verify your email address
# Complete your profile setup

Step 2: Connect WhatsApp Business

Connect your WhatsApp Business account to start sending and receiving messages.

JavaScript
// In your HiBot dashboard:
// 1. Go to Channels → WhatsApp
// 2. Click "Connect WhatsApp Business"
// 3. Follow the step-by-step guide
// 4. Verify your phone number
// 5. Start messaging!

Step 3: Send Your First Message

Use the API to send your first message through HiBot.

JavaScript
const response = await fetch('https://api.hibot.live/v1/messages', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN'
  },
  body: JSON.stringify({
    to: 'RECIPIENT_PHONE_NUMBER',
    type: 'text',
    text: {
      body: 'Hello from HiBot!'
    }
  })
});

const data = await response.json();
console.log(data);

Authentication

Learn how to authenticate your requests to the HiBot API.

API Keys

All API requests require an API key for authentication. You can find your API keys in the HiBot dashboard under Settings → API Keys.

GET /v1/account

Include your API key in the Authorization header as a Bearer token.

JavaScript
const response = await fetch('https://api.hibot.live/v1/account', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY'
  }
});

Webhook Authentication

When setting up webhooks, you can verify requests using a signature header to ensure they come from HiBot.

JavaScript
// Verify webhook signature
const crypto = require('crypto');

function verifyWebhookSignature(payload, signature, secret) {
  const expectedSignature = crypto
    .createHmac('sha256', secret)
    .update(payload)
    .digest('hex');
    
  return crypto.timingSafeEqual(
    Buffer.from(signature),
    Buffer.from(expectedSignature)
  );
}

Messages API

Send and receive messages through the HiBot platform.

Send a Text Message

Send a simple text message to a WhatsApp user.

POST /v1/messages

Send a text message to a specific phone number.

JavaScript
const response = await fetch('https://api.hibot.live/v1/messages', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer YOUR_API_KEY'
  },
  body: JSON.stringify({
    to: '1234567890',
    type: 'text',
    text: {
      body: 'Hello! This is a test message from HiBot.'
    }
  })
});

const data = await response.json();
console.log(data);

Send a Template Message

Send a pre-approved template message to users. Template messages are required for initiating conversations.

POST /v1/messages

Send a template message with predefined structure and variables.

JavaScript
const response = await fetch('https://api.hibot.live/v1/messages', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer YOUR_API_KEY'
  },
  body: JSON.stringify({
    to: '1234567890',
    type: 'template',
    template: {
      name: 'order_confirmation',
      language: {
        code: 'en'
      },
      components: [
        {
          type: 'body',
          parameters: [
            {
              type: 'text',
              text: 'ABC123'
            },
            {
              type: 'text',
              text: 'John Doe'
            }
          ]
        }
      ]
    }
  })
});

Webhooks

Receive real-time updates about messages, delivery status, and more.

Setting Up Webhooks

Configure webhooks to receive notifications about various events in your HiBot account.

JavaScript
// Example webhook endpoint
app.post('/webhooks/hibot', (req, res) => {
  // Verify the webhook signature
  const signature = req.headers['x-hibot-signature'];
  const payload = JSON.stringify(req.body);
  
  if (!verifyWebhookSignature(payload, signature, WEBHOOK_SECRET)) {
    return res.status(401).send('Invalid signature');
  }
  
  // Process the webhook event
  const event = req.body;
  
  switch (event.type) {
    case 'message':
      handleMessage(event);
      break;
    case 'message_status':
      handleMessageStatus(event);
      break;
    case 'contact':
      handleContact(event);
      break;
  }
  
  res.status(200).send('OK');
});

Webhook Events

HiBot sends various types of webhook events that you can subscribe to.

JSON
// Message received event
{
  "type": "message",
  "timestamp": 1633046400,
  "message": {
    "id": "wamid.XXXXXXXXXXXXXXXXXXXXXXXX",
    "from": "1234567890",
    "type": "text",
    "text": {
      "body": "Hello, I need help with my order."
    }
  }
}

// Message status event
{
  "type": "message_status",
  "timestamp": 1633046500,
  "message_id": "wamid.XXXXXXXXXXXXXXXXXXXXXXXX",
  "status": "delivered",
  "recipient_id": "1234567890"
}

Setup WhatsApp Business

Complete guide to setting up your WhatsApp Business account with HiBot.

Prerequisites

Before you begin, make sure you have the following:

  • A Facebook Business Manager account
  • A verified business (if required in your country)
  • A phone number dedicated to your business (not used with personal WhatsApp)
  • Access to receive SMS or phone calls on that number

Step-by-Step Setup

Follow these steps to connect your WhatsApp Business account to HiBot:

  1. Log in to your HiBot dashboard
  2. Navigate to Channels → WhatsApp
  3. Click "Connect WhatsApp Business"
  4. Follow the on-screen instructions to connect your Facebook Business account
  5. Select or create a WhatsApp Business account
  6. Verify your phone number via SMS or phone call
  7. Complete the setup and start messaging

Troubleshooting

Common issues and how to resolve them.

Common Error Codes

Here are some common error codes you might encounter and how to fix them.

Error Code Description Solution
401 Unauthorized Check your API key and make sure it's valid
429 Rate Limit Exceeded Wait before sending more requests or upgrade your plan
131030 Message Undeliverable Recipient may have blocked your number or doesn't have WhatsApp
132000 Template Parameter Mismatch Check that your template parameters match the template definition