Version: 7.x-40.0.0
Beta

Convert Watch API

This feature is experimental at the moment!

Endpoint

POST /_signals/convert/es

Converts a watch definition in ES Watcher format into Signals format. The result of the conversion is returned in the response body. Furthermore, the response body will list any potential problems that were found during the conversion.

The watch is not stored in Signals. It is up to the caller to PUT the watch afterwards.

Request Body

A watch in ES Watcher format as a JSON document.

Responses

200 OK

The watch could be converted; the conversion is possibly only partial. The returned JSON document will then list potential problems.

400 Bad Request

The JSON document could not be parsed.

Examples

Basic

POST /_signals/convert/es
{
    "trigger": {
        "schedule": {
            "daily": {
                "at": "noon"
            }
        }
    },
    "input": {
        "simple": {
            "x": "y"
        }
    },
    "actions": {
        "my_action": {
            "email": {
                "to": "[email protected]",
                "subject": "Hello World",
                "body": "Hallo ",
                "attachments": "foo"
            }
        },
        "another_action": {
            "index": {
                "index": "foo",
                "execution_time_field": "holla"
            }
        }
    }
}

Response

200 OK
{
  "status" : "Watch was partially converted; One problem was encountered for attribute actions.email.type.attachments: Attachments are not supported",
  "signals_watch" : {
    "trigger" : {
      "schedule" : {
        "daily" : [
          {
            "at" : "12:00"
          }
        ]
      }
    },
    "checks" : [
      {
        "type" : "static",
        "name" : null,
        "target" : null,
        "value" : {
          "x" : "y"
        }
      }
    ],
    "actions" : [
      {
        "type" : "email",
        "name" : "my_action",
        "to" : [
          "[email protected]"
        ],
        "subject" : "Hello World",
        "text_body" : "Hallo "
      },
      {
        "type" : "index",
        "name" : "another_action",
        "checks" : [
          {
            "type" : "calc",
            "source" : "data.holla = execution_time;"
          }
        ],
        "index" : "foo"
      }
    ],
    "active" : true,
    "log_runtime_data" : false,
    "_meta" : { }
  },
  "detail" : {
    "actions.email.type.attachments" : [
      {
        "error" : "Attachments are not supported"
      }
    ]
  }
}

Not what you were looking for? Try the search.