Documentation

How to install NetSendo on your own server, configure it, and connect it to other software.

NetSendo is a self-hosted email and SMS marketing automation platform built with Laravel and Vue.js and shipped as Docker images. It is source-available software under the NetSendo EULA: the SILVER license is free, GOLD adds advanced features. These pages describe NetSendo 2.7.0; the code and release notes are on GitHub.

Quick Start

Install NetSendo with Docker Compose: requirements, .env, first start, administrator account, updates and backups.

Configuration

Environment variables, mailboxes and SMS providers, queue worker and scheduler, HTTPS reverse proxy, NMI.

API Reference

Every REST endpoint with its method, path and scope, plus API keys, rate limits, errors and examples.

Webhooks

The 15 events, their payloads, HMAC-SHA256 signature checks in PHP and Node.js, and failed deliveries.

AI Integration

Connect OpenAI, Anthropic, Google Gemini, xAI, OpenRouter or a local Ollama model for content and campaign planning.

MCP Server

Manage subscribers, campaigns and funnels from Claude, Cursor or VS Code through the Model Context Protocol.

Report a Bug

What to include in a bug report and where to send it.

Common tasks

Key facts

Topic	Details
Installation	Docker Compose; image ghcr.io/netsendo/netsendo; MySQL 8.4 and Redis 7
Web interface	http://localhost:5029 (bound to 127.0.0.1; use a reverse proxy with HTTPS)
REST API	https://your-domain.com/api/v1, Bearer API keys (ns_live_…) with 16 scopes
Rate limit	3,000 requests per minute per API key
Webhooks	15 events, signed with X-NetSendo-Signature (HMAC-SHA256)
Sending	SMTP, Gmail API, SendGrid or the built-in NMI; SMS via Twilio, SMSAPI, Vonage, MessageBird, Plivo
AI assistants	MCP server (@netsendo/mcp-client) using the same API

For AI agents

Every documentation page is also available as Markdown: request its URL with the header Accept: text/markdown. The list of pages is at /api/v1/docs and in llms.txt. More in NetSendo for AI agents.