ViveReply
ViveReply Core API v1.0

Technical Documentation

Learn how to integrate ViveReply's RAG automation, webhook handlers, and background worker queues into your active Shopify storefront strategy.

Platform Overview

ViveReply operates as a highly modular monorepo. Standard lead inquiries are parsed by our RAG context vectors, while queue-heavy re-engagement jobs, order checkouts, and checkout drop-off event logs run asynchronously using Redis and BullMQ inside apps/workers.

Authentication

All API requests must carry a valid token generated inside your ViveReply dashboard:

curl -X GET https://vivereply.com/api/v1/conversations \
  -H "Authorization: Bearer rb_live_8f3d8a9e"

Redis Worker Queue Architecture

ViveReply runs decoupled background jobs to process lost-customer follow-ups. You can programmatically inject re-engagement alerts into the queue payload:

// Adding a re-engagement flow to the BullMQ system
const flowQueue = new Queue('lost_customer_followup', { connection: redisClient });
await flowQueue.add('trigger_alert', { customerId: 'shopify_cust_941', delayDays: 30 });

GET /api/v1/conversations

Retrieves active conversation threads along with their lead retention phase status.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": "success",
  "data": [
    {
      "id": "conv_82739",
      "status": "RETRAINED",
      "channel": "whatsapp",
      "unreplied_count": 0
    }
  ]
}