Bzade Developer Documentation
Learn how businesses, developers, and personal websites integrate automated email scheduling and webhook payload dispatches into their applications with Bzade.
Overview & Concept
Bzade is an automation and execution engine designed to manage scheduled email dispatches and outgoing webhook payloads. Rather than maintaining custom cron jobs, Celery workers, or Bull queues on your servers, you can delegate scheduled execution to Bzade with high reliability and zero downtime.
Key capabilities include:
- Punctual Scheduling: Run one-time or recurring tasks (daily, weekly, monthly, yearly, custom timestamps).
- Dual Channel Delivery: Transmit formatted HTML emails or forward JSON HTTP payloads to external webhooks.
- Zero Maintenance Infrastructure: Securely connected through your verified SMTP or Gmail relays.
- Automated Fallbacks: Persistent storage with exponential retries and delivery status telemetry.
How Businesses & Personal Websites Integrate
Whether you are running an e-commerce platform, SaaS product, newsletter, or a personal website, integrating Bzade requires only a simple HTTP request from your backend or Jamstack static forms.
Common Use Cases
- Drip & Welcome Campaigns: When a user signs up on your website, trigger a 3-day welcome sequence by scheduling an email for
+72 hours. - Booking & Appointment Reminders: Schedule automated appointment reminders 24 hours and 1 hour before an event.
- Webhook Dispatcher: Dispatch state payloads to your analytics, CRM, or external partner APIs at precise future intervals.
- No-Code & Form Submissions: Connect Google Spreadsheets and web forms directly to Bzade's webhook ingestion engine.
REST API Reference
The Bzade REST API is organized around standard REST principles. All requests accept JSON payloads and return standard JSON responses with appropriate HTTP status codes.
Base endpoint: https://api.bzade.app/v1 (or your self-hosted backend).
Authentication
Authenticate your API requests by including your API key in the Authorization header formatted as a Bearer token:
Authorization: Bearer bz_live_your_api_key_here
Creating a Schedule
POST
/api/schedules
Creates a new automated schedule for a specific project.
| Field | Type | Description |
|---|---|---|
projectId |
String | Required. The UUID of the destination project. |
name |
String | A human-readable label for the job (e.g. "Customer Check-in"). |
channel |
String | emails for email dispatches or payload for webhook POST. |
schedule_type |
String | once for one-time or recurring. |
scheduled_for |
ISO 8601 | UTC timestamp when the task should first trigger. |
config |
Object | Delivery configuration (recipients, subject, message body, or webhook URL). |
curl -X POST https://api.bzade.app/v1/schedules \
-H "Authorization: Bearer bz_live_sec_99a812bc" \
-H "Content-Type: application/json" \
-d '{
"projectId": "proj_8291a92",
"name": "Order Followup",
"channel": "emails",
"schedule_type": "once",
"scheduled_for": "2026-10-30T10:00:00Z",
"config": {
"recipients": ["[email protected]"],
"subject": "How was your recent delivery?",
"body": "<p>Hi there, we hope you loved your order!</p>"
}
}'
Webhook & Payload Dispatching
When you set channel: "payload", Bzade dispatches a POST request to your specified target endpoint when the schedule matures.
{
"projectId": "proj_8291a92",
"name": "Sync Inventory Webhook",
"channel": "payload",
"schedule_type": "recurring",
"cron": "0 0 * * *",
"config": {
"target_url": "https://api.yourdomain.com/webhooks/inventory",
"headers": {
"X-Custom-Secret": "sec_custom_token"
},
"payload": {
"action": "recalculate_stock",
"timestamp": "2026-10-26T20:00:00Z"
}
}
}
Team Members & Access Roles
Bzade allows inviting team members and external collaborators to help manage email schedules, audit dispatches, and configure relays.
Available Roles
- Admin: Full permissions across projects, mail connections, member invitations, and workspace settings.
- Editor: Can compose, edit, pause, and test email and payload schedules. Cannot delete projects or alter billing.
- Viewer: Read-only access to review scheduled tasks, sent logs, and dispatches.
Access Scopes
You can grant Account Access to give members visibility over all current and future projects, or Project Access to restrict their access strictly to a chosen project.
Google Sheets Form Integration
Bzade allows capturing form submissions (such as career applications or leads) directly into a Google Spreadsheet using lightweight Google Apps Script endpoints.
Target Sheet ID: 127A2vUkkEuYzgUlHGWRoBngfDpUVO6NrQ7sw9lCkhs0
Range: Sheet1!B6:G (Columns: Full Name, Email, Phone Number, Interested Role, LinkedIn URL, About Me).
Node.js & JavaScript Example
import fetch from "node-fetch";
export async function scheduleEmailReminder(userEmail, appointmentDate) {
const response = await fetch("https://api.bzade.app/v1/schedules", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.BZADE_API_KEY}`,
"Content-Type": "application/json"
},
body: JSON.stringify({
projectId: process.env.BZADE_PROJECT_ID,
name: `Appointment Reminder: ${userEmail}`,
channel: "emails",
schedule_type: "once",
scheduled_for: new Date(appointmentDate.getTime() - 86400000).toISOString(),
config: {
recipients: [userEmail],
subject: "Reminder: Your appointment is tomorrow",
body: "<p>We look forward to seeing you tomorrow!</p>"
}
})
});
return await response.json();
}
Error Codes & Limits
| Status | Code | Meaning |
|---|---|---|
401 |
UNAUTHORIZED |
Missing or invalid Bearer API key. |
404 |
PROJECT_NOT_FOUND |
The specified project ID does not exist or belong to your account. |
422 |
VALIDATION_ERROR |
Invalid parameters or recipient email syntax. |
429 |
RATE_LIMIT_EXCEEDED |
You have exceeded your plan's monthly dispatch quota. |