Payload


payload json

The Schema

{
    "description": "optional",
    "enabled": 1,
    "name": "name of the tasks",
    "payload": {
        "attachments": {
            "/tmp/ok.jpg": "base64"
        },
        "metadata": {
            "key": "value"
        },
        "task": "command args"
    },
    "retries": 0,
    "target": "where to execute the task",
    "when": "when to execute it"
}
Field Mandatory description
description NO Description of the task
enabled NO Defaults to 1 (yes)
name YES Name of the task
payload YES payload for the task (check the payload schema)
retries NO The number of tries if the task fails, defaults to 0
target YES The name of the target where the task will be run
when YES schedule for the task

Payload schema

"payload": {
    "attachments": {
        "/tmp/ok.jpg": "base64"
    },
    "metadata": {
        "key": "value"
    },
    "task": "command args"
}

The payload is always sent to the clients that will be runing the task:

Field Mandatory description
attachments NO Extra files base64 encoded
metadata NO Metadata for the task
task YES command to execute
comments powered by Disqus