Skip to content
Developers

Build on Deplao

Connect Zalo, Facebook and Telegram to your website, n8n, sales software or in-house systems, or build an app that runs right inside Deplao.

QuickstartAPI referenceDownload openapi.json

REST API

307 JSON operations that share logic with the app UI.

Webhooks

Deplao POSTs events to your server, HMAC-signed with retries.

Real-time events

Socket.IO, SSE or polling, with catch-up after disconnects.

Apps (plugins)

Pages, chat panels, buttons and workflow nodes inside Deplao.

Quickstart

  • Local base URL: http://127.0.0.1:9900/api/v1
  • Authenticate with Authorization: Bearer dpk_… or X-Api-Key: dpk_…
  • The API is off by default. Keys are scoped by permission, account, IP and expiry; apps only run within the permissions you approve.
  • Import into Postman / Insomnia or hand it to your AI coding tool.
bash
# Send a message through the Public API, same pipeline as the app: shows in the chat, saved, triggers workflows
curl -X POST "http://127.0.0.1:9900/api/v1/accounts/0501234567/conversations/8899001122/messages" \
  -H "Authorization: Bearer dpk_xxx" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: order-HD1024-shipped" \
  -d '{"text":"Order HD1024 is on its way with GHN, tracking GHN5K2X9Q 🚚"}'

Guides

QuickstartAuthentication & permissionsConventionsSending messages & filesRealtime eventsWebhooksRemote access & securityIntegration recipesApps (plugins): get started in 10 minutesApps (plugins): referenceEvent catalogData model of the API & Plugin platform

API reference · 307 endpoints

Every endpoint by group, with parameters, request body and a curl command.

System4Health check, key info, server info.GETendpointsAccounts10Zalo, Facebook and Telegram accounts on the machine: list, status, connection, proxy.GETPOSTPUTPATCHendpointsChat44Conversations and messages on every channel: read, search, send, recall, react, pin, mark as read.GETPATCHDELETEPOSTPUTendpointsMedia13Upload files to send, download attachments, media library.GETPOSTDELETEPATCHendpointsLabels & quick replies30Conversation labels (local), quick replies, stickers.GETPOSTPATCHDELETEPUTendpointsGroups38Group chats: info, members, renaming, invite links.GETPOSTPATCHDELETEPUTendpointsContacts19Friends, friend requests, user lookup.GETPOSTDELETEPUTendpointsProduct catalog8GETPOSTDELETEPATCHendpointsCRM13Customers, CRM tags, notes, messaging campaigns.GETPATCHPOSTDELETEendpointsCampaigns15GETPOSTPATCHDELETEendpointsWorkflow16Automation workflows: read, edit, enable/disable, run, trigger.api events.GETPOSTPUTPATCHDELETEendpointsIntegrations9POS, shipping and payment connections: call adapter actions.GETPOSTPATCHDELETEendpointsERP49Tasks, projects, calendar, notes, attendance, leave, notifications.GETPOSTPATCHDELETEendpointsAI9AI assistants: chat, reply suggestions, usage statistics.GETPOSTendpointsReports1Overview, message volume, peak hours, campaign and workflow reports.GETendpointsEmployees13Manage employees, module permissions, account assignment.GETPOSTPATCHDELETEPUTendpointsEvents3Receive realtime events: Socket.IO, SSE, polling.GETendpointsWebhook8Register outbound webhooks signed with HMAC.GETPOSTPATCHDELETEendpointsPlugin5Routes registered by plugins, and plugin info.GETPOSTPUTPATCHDELETEendpoints