GETTING STARTED

Automation Quick Start

Welcome to the Automation documentation. Automation provides an enterprise-ready distributed scheduler and webhook ingestion engine. Follow this guide to register a job, configure retry strategies, and monitor executions.

Step 1: Dispatch a job using cURL

Authenticate using an API key and post a JSON payload to dispatch an immediate task.

curl -X POST https://api.automation.internal/v1/jobs/job-101/dispatch \ -H "Authorization: Bearer sk_live_89a02fb..." \ -H "Content-Type: application/json" \ -d '{ "parameters": { "sync_mode": "incremental", "batch_limit": 5000 } }'

SCHEDULING PRIMITIVES

Cron Expressions & Syntax

Standard 5-field cron syntax is supported across all worldwide IANA timezones (such as UTC, America/New_York, or Asia/Tokyo).

Expression	Meaning	Common Use Case
/5 * * *	Every 5 minutes	Telemetry gathering, heartbeats
0 * * * *	Every hour on the hour	Inventory reconciliation, cache purge
30 2 * * *	Daily at 02:30	Database backups & cold storage
0 9 * * 1	Mondays at 09:00	Weekly compliance digest, reports

SECURITY SPECIFICATION

Webhook Ingestion & Signature Verification

Verify every incoming payload with SHA-256 HMAC tokens. The Automation gateway enforces payload size caps (max 5MB) and automatic signature header checks before dispatching tasks to worker queues.

// Node.js Verification Example

const crypto = require('crypto'); function verifyWebhook(rawBody, signatureHeader, secret) { const expected = 'sha256=' + crypto .createHmac('sha256', secret) .update(rawBody) .digest('hex'); return crypto.timingSafeEqual(Buffer.from(signatureHeader), Buffer.from(expected)); }

API SPECIFICATION

Core Endpoints

GET

/v1/jobs

Retrieve paginated list of all active and paused automation jobs.

POST

/v1/jobs

POST

/v1/jobs/:id/trigger

Manually dispatch an execution cycle outside the regular schedule.