Back to Help Center
🔑
Developer 5 min read

API Keys & Developer Access

Generate API keys, understand rate limits, and integrate ViViDlyPro with other apps.

API Keys

ViViDlyPro provides a REST API for developers who want to integrate bot management into their own systems.

Generating an API Key

  1. Go to Settings → Developer → API Keys.
  2. Click Generate New Key.
  3. Give the key a name (e.g., "CRM Integration").
  4. Select permissions: Read Only, Read+Write, or Full Access.
  5. Click Create and copy the key immediately — it's shown only once.

Keeping API Keys Secure

  • Never share API keys publicly (e.g., in GitHub commits or public forums).
  • Each integration should use its own dedicated key.
  • Rotate keys periodically — regenerate by deleting old and creating new.
  • Use read-only keys wherever write access isn't needed.

API Endpoint Base URL

Production: https://api.vividlypro.com/v1

All requests require the header:

Authorization: Bearer YOUR_API_KEY

Common API Operations

  • GET /conversations — List recent conversations
  • GET /messages/:conversationId — Get messages for a conversation
  • POST /knowledge-base — Add a new Knowledge Base entry
  • PUT /knowledge-base/:id — Update an existing entry
  • GET /analytics/summary — Get message volume summary
  • POST /messages/send — Send a message to a specific WhatsApp number

Rate Limits

Free & Starter: 100 API calls/hour

Professional: 1,000 API calls/hour

Enterprise: Custom limits

Exceeding the limit returns HTTP 429. Implement exponential backoff in your integration.