Skip to main content
POST
/
external
/
whatsapp
curl -X POST "https://demo.api.vultlocal.com/api/v1/external/whatsapp" \
  -H "Content-Type: application/json" \
  -d '{
    "event": "message",
    "message": "What is my balance?",
    "from": "23279648205@c.us",
    "phoneE164": "+23279648205"
  }'

{
  "answer": "Your balance is 5,000 SLE",
  "status": "success"
}

Documentation Index

Fetch the complete documentation index at: https://docs.vultlocal.com/llms.txt

Use this file to discover all available pages before exploring further.

Receive and process WhatsApp messages via Agent-TS. Kapso is the supported transport; /api/v1/external/whatsapp remains only as a compatibility test bridge.

​
Endpoints

MethodEndpointDescription
POST/api/v1/external/whatsappCompatibility test bridge
GET/api/v1/webhooks/whatsappMeta webhook verification
POST/api/v1/webhooks/whatsappMeta webhook messages

​
External Client Request

​
event
string
required
Event type (e.g., message)
​
message
string
required
Message content from user
​
from
string
required
WhatsApp ID (e.g., 23279648205@c.us)
​
phoneE164
string
required
Phone number in E.164 format

​
Response

​
answer
string
Agent response message
​
status
string
Processing status (success, error)

​
Examples

curl -X POST "https://demo.api.vultlocal.com/api/v1/external/whatsapp" \
  -H "Content-Type: application/json" \
  -d '{
    "event": "message",
    "message": "What is my balance?",
    "from": "23279648205@c.us",
    "phoneE164": "+23279648205"
  }'

{
  "answer": "Your balance is 5,000 SLE",
  "status": "success"
}

​
Meta Business API

​
Verification (GET)

Meta sends a verification request when setting up the webhook: 
GET /api/v1/webhooks/whatsapp?hub.mode=subscribe&hub.verify_token=YOUR_TOKEN&hub.challenge=CHALLENGE
Return hub.challenge if hub.verify_token matches.

​
Messages (POST)

Meta sends incoming messages as POST requests with the message payload.

Agent-TS Webhooks

Detailed webhook configuration and message handling

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
event
string
required
​
message
string
required
​
from
string
required
​
phoneE164
string
required

Response

200 - application/json

Success

The response is of type object.