Developers

Reach vybeflow from your own code, or from an AI assistant over MCP. Every endpoint needs a tenant API key and runs only within that key's permissions.

Get a key

In the vybeflow console: Pengaturan → API Key. Choose what the key may do and when it expires. The key is shown once.

Connect an AI assistant

Each domain is its own MCP server with two tools. Install only the domains you need.

The packages are not on npm yet. Run them from source: clone the repo, npm install, then point your client at packages/<domain>/bin/cli.js.

{
  "mcpServers": {
    "vybeflow-inbox": {
      "command": "node",
      "args": ["/path/to/vybeflow-mcp/packages/inbox/bin/cli.js"],
      "env": { "VYBEFLOW_API_KEY": "vf_live_..." }
    }
  }
}

Try asking it

Once a server is connected, these are things you can just type. Each needs the permission shown — tick it when you mint the key, or the assistant will be refused mid-answer.

How many tickets are still open, and which has waited longest for a reply? needs inbox.read
Reply to ticket T-1042: tell them the parcel ships tomorrow morning. needs inbox.reply · asks you to confirm first
Find the contact on 6281234567890 and show me their ticket history. needs contact.read + inbox.read
Which campaign had the lowest open rate this month? needs campaign.read
Draft a campaign called "End of Month Promo" for WhatsApp. Do not send it. needs campaign.manage
Send the "End of Month Promo" campaign now. needs campaign.send · asks you to confirm first
Which products have fewer than 10 in stock? needs product.read
How much AI quota do I have left, and when does my plan renew? needs quota.read + billing.read
What are our customer service hours? needs tenant.setting.read

Call it directly

curl -H "x-api-key: vf_live_..." \
  https://vybeflow.vyber.id/api/campaign/campaigns

Machine-readable

Endpoints

contact 6

Endpoint	permission	risk
`GET /api/user/users` Daftar kontak pelanggan milik tenant.	`contact.read`	safe
`POST /api/user/users` Tambah satu kontak baru.	`contact.manage`	confirm
`PUT /api/user/users/:id` Ubah satu kontak.	`contact.manage`	confirm
`DELETE /api/user/users/:id` Hapus satu kontak. Tidak bisa dibatalkan.	`contact.delete`	destructive
`POST /api/user/users/import` Impor banyak kontak sekaligus.	`contact.manage`	confirm
`GET /api/user/users/campaign/:campaignID` Kontak yang termasuk dalam satu kampanye.	`contact.read`	safe

campaign 7

Endpoint	permission	risk
`GET /api/campaign/campaigns` Daftar kampanye beserta status dan jumlah penerima.	`campaign.read`	safe
`GET /api/campaign/campaigns/analytics` Ringkasan performa kampanye: terkirim, dibuka, gagal.	`campaign.read`	safe
`POST /api/campaign/campaigns` Buat kampanye baru. Membuat TIDAK mengirim — pakai campaign.send.	`campaign.manage`	confirm
`POST /api/campaign/campaigns/:id/send` MULAI mengirim kampanye ke seluruh penerimanya.	`campaign.send`	destructive
`POST /api/campaign/campaigns/:id/cancel` Hentikan kampanye yang sedang berjalan. Pesan yang sudah terkirim tetap terkirim.	`campaign.control`	confirm
`GET /api/campaign/campaigns/:id/progress` Kemajuan pengiriman satu kampanye.	`campaign.read`	safe
`DELETE /api/campaign/campaigns/:id` Hapus kampanye beserta statistiknya.	`campaign.manage`	destructive

inbox 7

Endpoint	permission	risk
`GET /api/ai/v1/tickets` Daftar tiket percakapan.	`inbox.read`	safe
`GET /api/ai/v1/tickets/stats` Jumlah tiket per channel dan per status.	`inbox.read`	safe
`GET /api/ai/v1/tickets/:ticketID` Satu tiket beserta riwayat pesannya.	`inbox.read`	safe
`GET /api/ai/v1/tickets/status/:status` Tiket dengan satu status tertentu.	`inbox.read`	safe
`POST /api/ai/v1/tickets` Buat tiket baru.	`inbox.manage`	confirm
`POST /api/ai/v1/tickets/:ticketID/reply` Kirim balasan ke pelanggan pada satu tiket.	`inbox.reply`	destructive
`POST /api/ai/v1/tickets/:ticketID/close` Tutup tiket.	`inbox.manage`	confirm

channel 5

Endpoint	permission	risk
`GET /api/channel/v1/channels` Daftar channel yang terhubung beserta statusnya.	`channel.read`	safe
`GET /api/channel/v1/channels/:channelId` Detail satu channel.	`channel.read`	safe
`GET /api/channel/v1/whatsapp/status` Status sambungan WhatsApp tenant.	`channel.read`	safe
`GET /api/channel/v1/whatsapp/cloud/templates` Template WhatsApp Cloud yang sudah disetujui Meta.	`channel.read`	safe
`POST /api/channel/v1/notification/send/whatsapp` Kirim satu pesan WhatsApp ke satu nomor.	`inbox.reply`	destructive

product 5

Endpoint	permission	risk
`GET /api/product/v1/products` Daftar produk milik tenant.	`product.read`	safe
`GET /api/product/v1/products/:productID` Detail satu produk.	`product.read`	safe
`POST /api/product/v1/products` Tambah produk baru.	`product.manage`	confirm
`PUT /api/product/v1/products/:productID` Ubah satu produk.	`product.manage`	confirm
`DELETE /api/product/v1/products/:productID` Hapus satu produk beserta gambarnya.	`product.manage`	destructive

billing 5

Endpoint	permission	risk
`GET /api/payment/v1/payment/history` Riwayat transaksi pembayaran tenant.	`billing.read`	safe
`GET /api/payment/v1/payment/history/:orderID` Satu transaksi berdasarkan orderID.	`billing.read`	safe
`GET /api/user/v1/dashboard/subscription` Paket langganan yang sedang aktif.	`billing.read`	safe
`GET /api/ai/v1/quota` Sisa kuota AI dan pesan untuk tenant ini.	`quota.read`	safe
`GET /api/ai/v1/usage` Riwayat pemakaian kuota.	`quota.read`	safe

tenant 2

Endpoint	permission	risk
`GET /api/user/v1/dashboard/setting` Profil perusahaan: nama, alamat, kontak, jam kerja.	`tenant.setting.read`	safe
`GET /api/user/v1/dashboard/tenant/list` Tenant yang dapat diakses pemegang kredensial ini.	`tenant.read`	safe