Open Bsp API

OpenBSP API

Open-source WhatsApp and Instagram Business Platform

Self-hostable, multi-tenant, AI-agent ready. Built with Deno 🦕 and Postgres 🐘, powered by Supabase ⚡

       

OpenBSP is designed for both individual businesses and service providers. You can use it to manage your own WhatsApp and Instagram messaging, or leverage its features to become a Meta Business Partner and offer messaging services to other organizations.

Table of contents

• Quickstart
• User interface
• n8n
• Claude Code plugin
• Description

Platforms

• Hosted version
• Migrating from another platform
• Self-host deployment

Channels

• WhatsApp integration
• Instagram integration
• App review
• WhatsApp Web integration (unofficial API)
• Slack integration

Development

• Architecture
• Local development

Community

• Related open-source projects
• Acknowledgments
• Community

Quickstart

Receive and send WhatsApp messages in two steps. Before you start (once): sign up at web.openbsp.dev, connect your WhatsApp number (Integrations → WhatsApp), and create an API key (Settings → API Keys). Every call below sends two headers: apikey (the public Supabase key) and api-key (your secret key).

The API is PostgREST over the database, every table is an endpoint, so you can use plain REST or any Supabase SDK (JS, Python, Dart, …).

1. Receive messages — register a webhook; OpenBSP POSTs every new message to your URL:

curl -X POST 'https://nheelwshzbgenpavwhcy.supabase.co/rest/v1/webhooks' \
  -H 'apikey: ' -H 'api-key: ' \
  -H 'Content-Type: application/json' \
  -d '{
    "organization_id": "<ORG_ID>",
    "table_name": "messages",
    "operations": ["insert"],
    "url": "https://your-app.com/webhook"
  }'

Your endpoint receives the messages table row as is, wrapped in a thin envelope:

{
  "entity": "messages",
  "action": "insert",
  "data": {
    // the row, exactly as stored
    "id": "9b2d…",
    "organization_id": "…",
    "conversation_id": "…",
    "external_id": "wamid.…",
    "service": "whatsapp",
    "organization_address": "",
    "conversation_address": "5491155551234",
    "sender_address": "5491155551234",
    "content": {
      "version": "1",
      "type": "text",
      "kind": "text",
      "text": "Hi!"
    },
    "status": { "delivered": "2026-07-17T12:00:00Z" },
    "timestamp": "2026-07-17T12:00:00Z"
  }
}

Reply when data.sender_address is set — the contact authored it; it is null on your own outgoing rows, which the webhook also fires for (and, with "update", for status changes).

2. Send a message — insert a row; OpenBSP dispatches it to WhatsApp: