API ReferenceSchedule Triggers
Create a schedule
POST /schedules
Create a schedule
Create a schedule.
https://api.edgecron.com/v1/schedules
Authentication required
Send `X-Key-ID`, `X-Timestamp`, and `X-Signature` with every request. The signature is lowercase hex HMAC-SHA256 over `timestamp + "\n" + payload`.
Parameters
This endpoint does not define path or query parameters.
Request body
| Parameters | Type | Required | Description |
|---|---|---|---|
name | string | Yes | - |
cron_expr | string | Yes | - |
timezone | string | No | Default: UTC. |
payload | object | No | JSON payload forwarded to the target endpoint. |
endpoint_ids | integer[] | No | Target endpoint IDs. Empty = all active endpoints |
{
"name": "billing-webhook",
"cron_expr": "*/5 * * * *",
"timezone": "UTC",
"payload": {},
"endpoint_ids": [
1
]
}Response
All successful responses use the EdgeCron API envelope.
{
"code": 0,
"message": "success",
"request_id": "req_abc123",
"data": {
"id": 101,
"app_id": "app_123",
"name": "billing-webhook",
"cron_expr": "*/5 * * * *",
"timezone": "Asia/Shanghai",
"payload": {},
"status": "active",
"next_run_at": "2026-07-01T12:00:00Z",
"created_at": "2026-07-01T12:00:00Z",
"updated_at": "2026-07-01T12:00:00Z",
"endpoint_ids": [
1
],
"endpoint_names": {}
}
}Schema
| Parameters | Type | Required | Description |
|---|---|---|---|
id | integer | No | Resource identifier. |
app_id | string | No | Application identifier. |
name | string | No | - |
cron_expr | string | No | Example: */5 * * * *. |
timezone | string | No | Example: Asia/Shanghai. |
payload | object | No | JSON payload forwarded to the target endpoint. |
status | active / paused / deleted | No | Allowed: active, paused, deleted. |
next_run_at | string (date-time) | No | - |
created_at | string (date-time) | No | Creation timestamp. |
updated_at | string (date-time) | No | Last update timestamp. |
endpoint_ids | integer[] | No | Target endpoint IDs. Empty = all active endpoints |
endpoint_names | Record string to string | No | Endpoint ID → name map for display convenience |