Skip to main content

Quick Start Guide

Get started with MessagePipe in minutes. This guide will walk you through creating your first email template and sending a message.

Prerequisites​

  • A MessagePipe account
  • An API key (generated from your dashboard)
  • A configured email, message or push notification provider

Step 1: Get Your API Key​

  1. Log into your MessagePipe dashboard
  2. Select your preferred Project → Click on API Keys
  3. Click Create API Key
  4. Copy the generated API key and store it in a secure place (you won't see it again!)

Step 2: Create Your First Email Template​

curl -X POST "https://mzl-email-template-engine.dev.zero.mangozestlabs.com/templates?projectId=your-project-id&name=welcome-email&subject=Welcome+to+Our+Platform" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "Content-Type: text/html" \
  -d '<h1>Welcome!</h1><p>Thanks for joining {{companyName}}.</p>'

Response:

{
  "id": "template-uuid",
  "name": "welcome-email",
  "body": "<h1>Welcome!</h1><p>Thanks for joining {{companyName}}.</p>",
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z",
  "project": {
    "id": "project-uuid",
    "name": "project-name"
  }
}

Step 3: Send Your First Email​

curl -X POST "https://mzl-email-template-engine.dev.zero.mangozestlabs.com/email/send" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "templateId": "template-uuid",
    "to": "user@example.com",
    "variables": {
      "companyName": "Nobu"
    }
  }'

Response:

{
  "message": "Email sent successfully",
  "messageId": "msg-id"
}

Step 4: Create and Send a Message (WhatsApp, SMS, Telegram, etc.)​

# Create a message template
curl -X POST "https://mzl-email-template-engine.dev.zero.mangozestlabs.com/message-templates" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "projectId": "your-project-id",
    "name": "verification-message",
    "body": "Your verification code is {{code}}."
  }'

# Send via your preferred provider
curl -X POST "https://mzl-email-template-engine.dev.zero.mangozestlabs.com/message/send" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "templateId": "message-template-uuid",
    "to": "+1234567890",
    "preferredProvider": "twilio",
    "variables": {
      "code": "123456"
    }
  }'

The to field format depends on the provider: phone number (e.g. +2348012345678) for SMS, WhatsApp and Signal; chat ID (e.g. 123456789) for Telegram.

What's Next?​

Now that you've sent your first messages, explore these topics:

Common Issues​

Authentication Error (401)​

  • Verify your API key is correct
  • Ensure you're using x-api-key header for sending operations
  • Check that your API key hasn't been disabled

Template Not Found (404)​

  • Verify the template ID exists
  • Ensure you're using the correct project context

Provider Configuration Missing​

  • Configure at least one email, message or push notification provider in your project settings
  • Enable the provider in your configuration

Testing the API​

Use our API Reference page to test endpoints interactively with your actual API key.