Trigger Cron Job

Manually trigger a cron job execution immediately, regardless of its schedule. This is useful for testing or when you need to run a job outside its normal schedule.

Path Parameters

string

required

Your A1Base account ID

string

required

The unique identifier of the cron job to trigger (UUID format)

Response

object

Execution result information

Show Execution Result

string

Unique identifier for this execution

string

Execution status: success, failure, error, timeout

integer

HTTP response code from the endpoint

string

Response body from the endpoint (truncated to 1KB)

string

ISO 8601 timestamp of when the job was executed

Manual triggers bypass the schedule and execute immediately. The job must be active (is_active: true) to be triggered.

curl -X POST "https://api.a1base.com/v1/cron-jobs/{accountId}/trigger/550e8400-e29b-41d4-a716-446655440000" \
  -H "X-API-Key: your-api-key" \
  -H "X-API-Secret: your-api-secret"

const axios = require('axios');

const triggerCronJob = async (cronJobId) => {
  try {
    const response = await axios.post(
      `https://api.a1base.com/v1/cron-jobs/{accountId}/trigger/${cronJobId}`,
      {},
      {
        headers: {
          'X-API-Key': 'your-api-key',
          'X-API-Secret': 'your-api-secret'
        }
      }
    );
    
    console.log('Execution result:', response.data);
  } catch (error) {
    console.error('Error:', error.response.data);
  }
};

triggerCronJob('550e8400-e29b-41d4-a716-446655440000');

import requests

def trigger_cron_job(cron_job_id):
    url = f"https://api.a1base.com/v1/cron-jobs/{{accountId}}/trigger/{cron_job_id}"
    
    headers = {
        "X-API-Key": "your-api-key",
        "X-API-Secret": "your-api-secret"
    }
    
    response = requests.post(url, headers=headers)
    
    if response.status_code == 200:
        print("Execution result:", response.json())
    else:
        print("Error:", response.status_code, response.json())

trigger_cron_job("550e8400-e29b-41d4-a716-446655440000")

{
  "data": {
    "execution_id": "exe_123456789",
    "status": "success",
    "response_code": 200,
    "response_body": "{\"message\": \"Report generated successfully\", \"report_id\": \"rpt_98765\"}",
    "executed_at": "2024-01-25T15:45:00Z"
  }
}

{
  "data": {
    "execution_id": "exe_987654321",
    "status": "failure",
    "response_code": 500,
    "response_body": "{\"error\": \"Database connection failed\"}",
    "executed_at": "2024-01-25T15:45:00Z"
  }
}

{
  "data": {
    "execution_id": "exe_456789123",
    "status": "timeout",
    "response_code": null,
    "response_body": "Request timed out after 30 seconds",
    "executed_at": "2024-01-25T15:45:00Z"
  }
}

Use Cases

Testing New Endpoints

Test your endpoint before enabling scheduled execution:

Create the cron job with is_active: false
Trigger it manually to verify it works
Update to is_active: true when ready

On-Demand Execution

Run scheduled tasks outside their normal schedule:

Generate reports on demand
Process data immediately
Respond to user actions

Debugging Failed Jobs

When a scheduled execution fails:

Check the logs to understand the issue
Fix the problem
Manually trigger to verify the fix

Initial Data Load

Use manual triggers for initial setup:

Load historical data
Populate caches
Initialize systems

Important Notes

The cron job must be active (is_active: true) to be triggered
Manual triggers count towards your API rate limits
Execution follows the same retry logic as scheduled runs
Webhook callbacks will be triggered as configured

Error Responses

Cron job not found

{
  "detail": "Cron job not found"
}

Cron job is not active

{
  "detail": "Cron job is not active"
}

A1Cron

Getting Started with A1Cron

Cron Job Management

Monitoring & Logs

Trigger Cron Job

Path Parameters

Response

Use Cases

Important Notes

Error Responses

​Path Parameters

​Response

​Use Cases

​Important Notes

​Error Responses

Path Parameters

Response

Use Cases

Important Notes

Error Responses