Skip to main content

​
🚀 What you’ll build

You’ll set up your Vambe account and channel, create an API key, and make your first API request.
This guide takes about 10 minutes to complete. By the end, you’ll have made your first successful API call to Vambe.

​
1) Prerequisites

Before you start, you’ll need:
  • A Vambe account with the role Owner
Don’t have an account yet? Create one at app.vambeai.com/login
Want to connect channels? Check out our Connect your first channel guide to set up WhatsApp, Instagram, Webchat, or Messenger for receiving customer messages.

​
2) Create your API key

1

Navigate to Developers

Go to app.vambeai.com/developers and open the API Keys section.
2

Create New Key

Click the New API Key button to open the creation dialog.
3

Configure Key Details

  • Name: Give it a descriptive name (e.g., “Server”, “Zapier”, “Development”) - Role: Choose the appropriate permission level
4

Select Role

Choose the appropriate role for your use case:
RoleDescriptionUse Case
OWNERFull organization controlInitial testing, admin tasks
ADMINAdministrative accessTeam management
SUPER_ADMINExtended system accessAdvanced operations
AGENTStandard operationsDaily tasks, integrations
5

Create and Store

Click Create, then reveal and copy your API key. Store it securely in your environment variables or secret manager.
Security Best Practices: - Treat API keys like passwords—never commit them to git - Use environment variables: VAMBE_API_KEY=your_key_here - Rotate or delete unused keys from the Developers page - Prefer least-privilege roles for production keys

​
3) Your first API call

Vambe authenticates server-side requests via the x-api-key header. Replace YOUR_API_KEY with your newly created key. 
curl -X GET \
  -H "x-api-key: YOUR_API_KEY" \
  https://api.vambe.me/health/ping

​
Expected Response

{
  "status": "ok",
  "message": "pong",
  "date": "2025-01-01T12:00:00.000Z"
}
  • Latency simulation: Add ?sleep=500 to test response times: .../health/ping?sleep=500 - Database health check: Use GET /health for a full system check including database connectivity - Postman setup: Add a header x-api-key: YOUR_API_KEY to your request

​
4) Next steps

Congratulations! You’ve successfully made your first API call to Vambe.
Here’s what to explore next:

API Reference

Explore all available endpoints for channels, contacts, and webhooks

Integration Guide

Learn how to integrate Vambe into your existing workflows

Team Management

Invite teammates and configure role-based access

Webhooks

Set up real-time notifications for events
Need help? Contact our support team or check the API Reference section for detailed endpoint documentation.