Create Cron Job

curl -X POST https://api.a1base.com/v1/cron-jobs/{accountId}/create \
  -H "X-API-Key: your-api-key" \
  -H "X-API-Secret: your-api-secret" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Daily Sales Report",
    "description": "Generate comprehensive sales report",
    "endpoint_url": "https://api.company.com/reports/daily",
    "method": "POST",
    "headers": {
      "Authorization": "Bearer report-token",
      "Content-Type": "application/json"
    },
    "body": "{\"report_type\": \"sales\", \"format\": \"pdf\"}",
    "timezone": "America/New_York",
    "schedule_config": {
      "repeat_type": "days",
      "repeat_every": 1,
      "time": "09:00",
      "end_type": "never"
    },
    "retry_config": {
      "max_retries": 3,
      "retry_delay_seconds": 300,
      "timeout_seconds": 30
    },
    "callbacks": {
      "success_url": "https://webhooks.company.com/cron-success",
      "failure_url": "https://webhooks.company.com/cron-failure"
    },
    "tags": ["reports", "daily", "sales"],
    "is_active": true
  }'

const axios = require('axios');

const createCronJob = async () => {
  const cronJobData = {
    name: "Daily Sales Report",
    description: "Generate comprehensive sales report",
    endpoint_url: "https://api.company.com/reports/daily",
    method: "POST",
    headers: {
      "Authorization": "Bearer report-token",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      report_type: "sales",
      format: "pdf"
    }),
    timezone: "America/New_York",
    schedule_config: {
      repeat_type: "days",
      repeat_every: 1,
      time: "09:00",
      end_type: "never"
    },
    retry_config: {
      max_retries: 3,
      retry_delay_seconds: 300,
      timeout_seconds: 30
    },
    callbacks: {
      success_url: "https://webhooks.company.com/cron-success",
      failure_url: "https://webhooks.company.com/cron-failure"
    },
    tags: ["reports", "daily", "sales"],
    is_active: true
  };

  try {
    const response = await axios.post(
      'https://api.a1base.com/v1/cron-jobs/{accountId}/create',
      cronJobData,
      {
        headers: {
          'X-API-Key': 'your-api-key',
          'X-API-Secret': 'your-api-secret',
          'Content-Type': 'application/json'
        }
      }
    );
    
    console.log('Cron job created:', response.data);
  } catch (error) {
    console.error('Error:', error.response.data);
  }
};

createCronJob();

import requests
import json

def create_cron_job():
    url = "https://api.a1base.com/v1/cron-jobs/{accountId}/create"
    
    headers = {
        "X-API-Key": "your-api-key",
        "X-API-Secret": "your-api-secret",
        "Content-Type": "application/json"
    }
    
    data = {
        "name": "Daily Sales Report",
        "description": "Generate comprehensive sales report",
        "endpoint_url": "https://api.company.com/reports/daily",
        "method": "POST",
        "headers": {
            "Authorization": "Bearer report-token",
            "Content-Type": "application/json"
        },
        "body": json.dumps({
            "report_type": "sales",
            "format": "pdf"
        }),
        "timezone": "America/New_York",
        "schedule_config": {
            "repeat_type": "days",
            "repeat_every": 1,
            "time": "09:00",
            "end_type": "never"
        },
        "retry_config": {
            "max_retries": 3,
            "retry_delay_seconds": 300,
            "timeout_seconds": 30
        },
        "callbacks": {
            "success_url": "https://webhooks.company.com/cron-success",
            "failure_url": "https://webhooks.company.com/cron-failure"
        },
        "tags": ["reports", "daily", "sales"],
        "is_active": True
    }
    
    response = requests.post(url, headers=headers, json=data)
    
    if response.status_code == 201:
        print("Cron job created:", response.json())
    else:
        print("Error:", response.status_code, response.json())

create_cron_job()

{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Daily Sales Report",
    "description": "Generate comprehensive sales report",
    "endpoint_url": "https://api.company.com/reports/daily",
    "schedule": "0 9 * * *",
    "method": "POST",
    "headers": {
      "Authorization": "Bearer report-token",
      "Content-Type": "application/json"
    },
    "body": "{\"report_type\": \"sales\", \"format\": \"pdf\"}",
    "is_active": true,
    "timezone": "America/New_York",
    "repeat_type": "days",
    "repeat_every": 1,
    "days_of_week": null,
    "hours": 9,
    "minutes": 0,
    "end_type": "never",
    "end_date": null,
    "end_occurrences": null,
    "max_retries": 3,
    "retry_delay_seconds": 300,
    "timeout_seconds": 30,
    "success_callback_url": "https://webhooks.company.com/cron-success",
    "failure_callback_url": "https://webhooks.company.com/cron-failure",
    "tags": ["reports", "daily", "sales"],
    "next_run_at": "2024-01-26T14:00:00Z",
    "last_run_at": null,
    "consecutive_failures": 0,
    "created_at": "2024-01-25T10:30:00Z",
    "updated_at": "2024-01-25T10:30:00Z"
  }
}

Create a new scheduled task that will execute HTTP requests at specified intervals.

Path Parameters

string

required

Your A1Base account ID

Request Body

string

required

A descriptive name for your cron job

string

Detailed description of what this cron job does

string

required

The URL to call when the cron job executes. Must be a valid HTTP/HTTPS URL.

string

required

HTTP method to use: GET, POST, PUT, DELETE

object

HTTP headers to include with each request. Common headers include Authorization, Content-Type, etc.Example:

{
  "Authorization": "Bearer your-token",
  "Content-Type": "application/json"
}

string

Request body for POST/PUT methods. Must be a string (JSON string if sending JSON).

string

required

Timezone for schedule execution (e.g., “America/New_York”, “UTC”, “Europe/London”)

object

required

Schedule configuration object

Show Schedule Config Properties

string

required

Type of repetition: hourly, days, weeks, months, years

integer

required

Frequency of repetition (e.g., 1 = every day, 2 = every 2 days)

string

required

Time in 24-hour format “HH:MM” (e.g., “09:00”, “14:30”)

array

Required for weekly schedules. Array of day numbers:

“0” = Sunday
“1” = Monday
“2” = Tuesday
“3” = Wednesday
“4” = Thursday
“5” = Friday
“6” = Saturday

string

required

How the schedule ends: never, on, after

string

ISO 8601 timestamp when to stop (required if end_type is “on”)

integer

Number of occurrences before stopping (required if end_type is “after”)

object

Retry configuration for failed requests

Show Retry Config Properties

integer

default:"3"

Maximum number of retry attempts (0-10)

integer

default:"60"

Seconds to wait between retries

integer

default:"30"

Maximum seconds to wait for response

object

Webhook URLs for execution notifications

Show Callback Properties

string

URL to call on successful execution

string

URL to call on failed execution

array

Array of tags for organization and filtering

boolean

default:"true"

Whether the cron job should start active

Response

Returns the created cron job object with generated ID and calculated next run time.

curl -X POST https://api.a1base.com/v1/cron-jobs/{accountId}/create \
  -H "X-API-Key: your-api-key" \
  -H "X-API-Secret: your-api-secret" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Daily Sales Report",
    "description": "Generate comprehensive sales report",
    "endpoint_url": "https://api.company.com/reports/daily",
    "method": "POST",
    "headers": {
      "Authorization": "Bearer report-token",
      "Content-Type": "application/json"
    },
    "body": "{\"report_type\": \"sales\", \"format\": \"pdf\"}",
    "timezone": "America/New_York",
    "schedule_config": {
      "repeat_type": "days",
      "repeat_every": 1,
      "time": "09:00",
      "end_type": "never"
    },
    "retry_config": {
      "max_retries": 3,
      "retry_delay_seconds": 300,
      "timeout_seconds": 30
    },
    "callbacks": {
      "success_url": "https://webhooks.company.com/cron-success",
      "failure_url": "https://webhooks.company.com/cron-failure"
    },
    "tags": ["reports", "daily", "sales"],
    "is_active": true
  }'

const axios = require('axios');

const createCronJob = async () => {
  const cronJobData = {
    name: "Daily Sales Report",
    description: "Generate comprehensive sales report",
    endpoint_url: "https://api.company.com/reports/daily",
    method: "POST",
    headers: {
      "Authorization": "Bearer report-token",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      report_type: "sales",
      format: "pdf"
    }),
    timezone: "America/New_York",
    schedule_config: {
      repeat_type: "days",
      repeat_every: 1,
      time: "09:00",
      end_type: "never"
    },
    retry_config: {
      max_retries: 3,
      retry_delay_seconds: 300,
      timeout_seconds: 30
    },
    callbacks: {
      success_url: "https://webhooks.company.com/cron-success",
      failure_url: "https://webhooks.company.com/cron-failure"
    },
    tags: ["reports", "daily", "sales"],
    is_active: true
  };

  try {
    const response = await axios.post(
      'https://api.a1base.com/v1/cron-jobs/{accountId}/create',
      cronJobData,
      {
        headers: {
          'X-API-Key': 'your-api-key',
          'X-API-Secret': 'your-api-secret',
          'Content-Type': 'application/json'
        }
      }
    );
    
    console.log('Cron job created:', response.data);
  } catch (error) {
    console.error('Error:', error.response.data);
  }
};

createCronJob();

import requests
import json

def create_cron_job():
    url = "https://api.a1base.com/v1/cron-jobs/{accountId}/create"
    
    headers = {
        "X-API-Key": "your-api-key",
        "X-API-Secret": "your-api-secret",
        "Content-Type": "application/json"
    }
    
    data = {
        "name": "Daily Sales Report",
        "description": "Generate comprehensive sales report",
        "endpoint_url": "https://api.company.com/reports/daily",
        "method": "POST",
        "headers": {
            "Authorization": "Bearer report-token",
            "Content-Type": "application/json"
        },
        "body": json.dumps({
            "report_type": "sales",
            "format": "pdf"
        }),
        "timezone": "America/New_York",
        "schedule_config": {
            "repeat_type": "days",
            "repeat_every": 1,
            "time": "09:00",
            "end_type": "never"
        },
        "retry_config": {
            "max_retries": 3,
            "retry_delay_seconds": 300,
            "timeout_seconds": 30
        },
        "callbacks": {
            "success_url": "https://webhooks.company.com/cron-success",
            "failure_url": "https://webhooks.company.com/cron-failure"
        },
        "tags": ["reports", "daily", "sales"],
        "is_active": True
    }
    
    response = requests.post(url, headers=headers, json=data)
    
    if response.status_code == 201:
        print("Cron job created:", response.json())
    else:
        print("Error:", response.status_code, response.json())

create_cron_job()

{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Daily Sales Report",
    "description": "Generate comprehensive sales report",
    "endpoint_url": "https://api.company.com/reports/daily",
    "schedule": "0 9 * * *",
    "method": "POST",
    "headers": {
      "Authorization": "Bearer report-token",
      "Content-Type": "application/json"
    },
    "body": "{\"report_type\": \"sales\", \"format\": \"pdf\"}",
    "is_active": true,
    "timezone": "America/New_York",
    "repeat_type": "days",
    "repeat_every": 1,
    "days_of_week": null,
    "hours": 9,
    "minutes": 0,
    "end_type": "never",
    "end_date": null,
    "end_occurrences": null,
    "max_retries": 3,
    "retry_delay_seconds": 300,
    "timeout_seconds": 30,
    "success_callback_url": "https://webhooks.company.com/cron-success",
    "failure_callback_url": "https://webhooks.company.com/cron-failure",
    "tags": ["reports", "daily", "sales"],
    "next_run_at": "2024-01-26T14:00:00Z",
    "last_run_at": null,
    "consecutive_failures": 0,
    "created_at": "2024-01-25T10:30:00Z",
    "updated_at": "2024-01-25T10:30:00Z"
  }
}

Common Schedule Examples

Daily at 9 AM

{
  "repeat_type": "days",
  "repeat_every": 1,
  "time": "09:00"
}

Every 2 hours

{
  "repeat_type": "hourly",
  "repeat_every": 2,
  "time": "00:00"
}

Weekdays at 6 PM

{
  "repeat_type": "weeks",
  "repeat_every": 1,
  "time": "18:00",
  "days_of_week": ["1", "2", "3", "4", "5"]
}

Monthly on the 1st

{
  "repeat_type": "months",
  "repeat_every": 1,
  "time": "00:00"
}

30-day campaign

{
  "repeat_type": "days",
  "repeat_every": 1,
  "time": "10:00",
  "end_type": "after",
  "end_occurrences": 30
}

Get Cron Job Details Update Cron Job

A1Cron

Getting Started with A1Cron

Cron Job Management

Monitoring & Logs

Create Cron Job

Path Parameters

Request Body

Response

Common Schedule Examples

​Path Parameters

​Request Body

​Response

​Common Schedule Examples

Path Parameters

Request Body

Response

Common Schedule Examples