Create Schedule

LLM-friendly URL
POST
https://api.luzmo.com/0.1.0/schedule
API call form
Examples

A schedule is an automated synchronization or screenshot task. This way you can automatically send screenshots with a certain frequency or specify how frequently a dataset has to be synchronized. Schedules can be created, updated and deleted by all users or group members with at least modifying rights to the securable.

Parameters
Expand all Reset
properties *OBJECTrequired
type ENUM
subtype STRING
started_at DATETIME
frequency NUMBER
timezone STRING
active BOOLEAN
task OBJECT
Can be executed by:
Logged-in User
Can be associated to:
Alert
Dashboard
Dataset
User
Dissociate Plugin
Search Schedule
Did this page help you?
Yes No
Language
Shell
Node
Java
.NET
Python
PHP
Install
npm install @luzmo/nodejs-sdk
Example Request 
import Luzmo from '@luzmo/nodejs-sdk';
const client = new Luzmo({
  api_key: '<your Luzmo API key>',
  api_token: '<your Luzmo API token>',
  host: 'https://api.luzmo.com'
});


const response = await client.create('schedule',
  {
    type: "screenshot",
    subtype: "export",
    started_at: "2017-08-30T14:30:15Z",
    frequency: 1440,
    task: {
      type: "png",
      locale_id: "en",
      screenmode: "desktop",
      emails: [
        "test-user@documentation.com"
      ]
    },
    active: true
  }
);
You are not authenticated.
Log in to try
Example Response
200
400
500
{
  "id": "29db3c0e-be2b-488b-9b54-d1d9ae9dff3a",
  "task": null,
  "started_at": "2017-08-30T14:30:15Z",
  "frequency": 1440,
  "retries": 0,
  "active": true,
  "completed_at": "2018-09-03T12:38:18.614Z",
  "created_at": "2018-09-03T12:38:18.630Z",
  "updated_at": "2018-09-03T12:38:18.656Z",
  "last_scheduled_at": null,
  "user_id": "b0d76f5d-f3da-4c55-9497-d8457ccdccda",
  "securable_id": "b3cfbfc2-a9c0-48e3-b726-b93bdb569bfa",
  "scheduled_at": "2018-09-04T12:38:18.614Z",
  "timezone": "Europe/Brussels"
}