SendSyntix

Documentation

Everything you need to integrate SendSyntix into your application. From quick start guides to complete API reference.

Quick Start

Get up and running in minutes

API Reference

Complete API documentation

SDKs

Official client libraries

Security

Best practices and compliance

Getting Started

Channels

API Reference

SDKs

Introduction

SendSyntix is a unified messaging platform that synthesizes all your communication channels into a single, powerful API. Whether you need to send transactional emails, SMS notifications, push messages, or webhook events, SendSyntix provides a consistent interface to manage all your messaging needs.

Core Concepts

  • Channels - Different messaging mediums (email, SMS, push, webhooks)
  • Messages - Individual communications sent through channels
  • Templates - Reusable message formats with dynamic content
  • Events - Delivery status updates and engagement tracking

Quick Start

Follow these steps to send your first message with SendSyntix.

1

Install the SDK

bash
npm install sendsyntix
2

Initialize the client

typescript
import { SendSyntix } from 'sendsyntix'

const client = new SendSyntix({
  apiKey: process.env.SENDSYNTIX_API_KEY
})
3

Send your first message

typescript
await client.send({
  channel: 'email',
  to: 'user@example.com',
  subject: 'Welcome to SendSyntix',
  template: 'welcome',
  data: {
    name: 'John',
    company: 'Acme Inc'
  }
})

API Reference

The SendSyntix API is organized around REST. Our API accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes.

Base URL

https://api.sendsyntix.com/v1
POST/messagesSend a message through any channel
GET/messages/:idRetrieve a specific message and its status
GET/messagesList all messages with optional filters
POST/templatesCreate a new message template
GET/analytics/overviewGet delivery and engagement metrics

Authentication

Authenticate your API requests using API keys. Include your API key in the Authorization header of every request.

bash
curl https://api.sendsyntix.com/v1/messages \
  -H "Authorization: Bearer sk_live_your_api_key" \
  -H "Content-Type: application/json"

Security Best Practices

  • Never expose your API keys in client-side code
  • Use environment variables to store API keys
  • Rotate your keys periodically
  • Use separate keys for development and production