Scheduled Sends API
Schedule one-time HTTP requests to be delivered at a specific date and time.
Endpoints
| Method | Path | Description |
|---|---|---|
POST | /api/scheduled-sends | Create scheduled send |
GET | /api/scheduled-sends | List scheduled sends |
GET | /api/scheduled-sends/{id} | Get scheduled send |
PATCH | /api/scheduled-sends/{id} | Update scheduled send |
DELETE | /api/scheduled-sends/{id} | Cancel scheduled send |
POST | /api/scheduled-sends/{id}/send-now | Trigger immediately |
Scheduled Send Object
{
"id": "uuid",
"organization_id": "org_xxx",
"name": "Weekly report trigger",
"description": "Triggers the weekly report generation endpoint",
"url": "https://api.example.com/reports/generate",
"method": "POST",
"headers": "{\"X-Api-Key\": \"secret\"}",
"payload": "{\"type\": \"weekly\"}",
"scheduled_for": "2026-03-15T14:00:00.000Z",
"timezone": "UTC",
"status": "pending",
"attempts": 0,
"max_attempts": 3,
"response_status": null,
"response_body": null,
"error_message": null,
"latency_ms": null,
"sent_at": null,
"created_at": "2026-03-08T10:00:00.000Z",
"updated_at": "2026-03-08T10:00:00.000Z"
}Status Values
| Status | Description |
|---|---|
pending | Waiting to be sent at the scheduled time |
sending | Currently being processed |
sent | Successfully delivered |
failed | Delivery failed after all retry attempts |
cancelled | Manually cancelled |
Create Scheduled Send
curl -X POST https://api.hookbase.app/api/scheduled-sends \
-H "Authorization: Bearer {token}" \
-H "Content-Type: application/json" \
-d '{
"name": "Deploy notification",
"url": "https://api.example.com/webhooks/deploy",
"method": "POST",
"headers": {"Content-Type": "application/json"},
"payload": {"version": "2.1.0", "environment": "production"},
"scheduledFor": "2026-03-15T14:00:00Z",
"timezone": "America/New_York",
"maxAttempts": 3
}'Parameters
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | Display name |
description | string | No | Optional description |
url | string | Yes | Target URL (http/https) |
method | string | No | HTTP method (default: POST) |
headers | object | No | Custom HTTP headers |
payload | string/object | No | Request body |
scheduledFor | string | Yes | ISO 8601 timestamp (must be in the future) |
timezone | string | No | IANA timezone (default: UTC) |
maxAttempts | number | No | Max retry attempts (default: 3) |
List Scheduled Sends
curl https://api.hookbase.app/api/scheduled-sends?status=pending \
-H "Authorization: Bearer {token}"Query Parameters
| Parameter | Description |
|---|---|
status | Filter by status: pending, sending, sent, failed, cancelled |
page | Page number (default: 1) |
pageSize | Items per page (default: 20, max: 100) |
Cancel Scheduled Send
curl -X DELETE https://api.hookbase.app/api/scheduled-sends/{id} \
-H "Authorization: Bearer {token}"Only pending and failed sends can be cancelled.
Send Now
Trigger a scheduled send immediately, regardless of its scheduled time:
curl -X POST https://api.hookbase.app/api/scheduled-sends/{id}/send-now \
-H "Authorization: Bearer {token}"Only pending and failed sends can be triggered.
Retry Behavior
When a scheduled send fails (non-2xx response or network error):
- The
attemptscounter increments - If
attempts < maxAttempts, status resets topendingfor retry on the next scheduler cycle (runs every minute) - If
attempts >= maxAttempts, status is set tofailed
See Also
- Cron Jobs Guide — Recurring scheduled deliveries
- Cron Jobs API — Cron job API reference