Metaplane MonitorResultTrigger

Metaplane MonitorResultTrigger
Certified
Fire an execution when a Metaplane monitor's status changes

Polls the status of a single monitor at each interval and fires only when the status differs from the last-seen value, so an unchanged status never re-fires the trigger every interval. The first evaluation only establishes the baseline status and does not fire.

Fails with a clear error if the monitor has never been run (HTTP 404).

yaml
type: io.kestra.plugin.metaplane.MonitorResultTrigger

Examples

Fire when a Metaplane monitor's status changes

yaml
id: metaplane_on_result
namespace: company.team

triggers:
  - id: on_monitor_result
    type: io.kestra.plugin.metaplane.MonitorResultTrigger
    apiToken: "{{ secret('METAPLANE_API_TOKEN') }}"
    monitorId: "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    interval: PT5M

tasks:
  - id: handle_result
    type: io.kestra.plugin.core.log.Log
    message: "Monitor result: {{ trigger.status }}"

Properties

apiToken *string

Metaplane API token

API token used to authenticate against the Metaplane API. Generate one at https://app.metaplane.dev/account/manage-tokens and store it as a Kestra secret.

monitorId *string

Monitor ID

UUID of the Metaplane monitor to watch.

allowConcurrent boolean

Defaultfalse

Specifies whether a trigger is allowed to start a new execution even if a previous run is still in progress.

baseUrl string

Defaulthttps://dev.api.metaplane.dev

Metaplane API base URL

Base endpoint for all Metaplane API calls. Defaults to https://dev.api.metaplane.dev.

interval string

DefaultPT5M

Formatduration

How often to check the monitor's status

ISO-8601 duration. Defaults to PT5M.

options

HTTP client options

Optional HTTP configuration (timeouts, proxy, SSL) applied to every Metaplane API call.

Definitions

io.kestra.core.http.client.configurations.HttpConfiguration

allowFailedbooleanstring

Defaultfalse

If true, allow a failed response code (response code >= 400)

allowedResponseCodesarray

SubTypeinteger

List of response code allowed for this request

auth

The authentication to use.

io.kestra.core.http.client.configurations.BasicAuthConfiguration

type*object

passwordstring

The password for HTTP basic authentication.

usernamestring

The username for HTTP basic authentication.

io.kestra.core.http.client.configurations.BearerAuthConfiguration

type*object

tokenstring

The token for bearer token authentication.

io.kestra.core.http.client.configurations.DigestAuthConfiguration

type*object

passwordstring

The password for HTTP Digest authentication.

usernamestring

The username for HTTP Digest authentication.

defaultCharsetstring

DefaultUTF-8

The default charset for the request.

java.nio.charset.Charset

enabledTcpExtendedKeepAlivebooleanstring

Defaulttrue

Whether to enable TCP Keep-Alive extended socket options (TCP_KEEPIDLE, TCP_KEEPINTERVAL, TCP_KEEPCOUNT).

Set to false when running on Windows workers, as these extended socket options are not supported by the Windows JDK and will cause connection failures.

followRedirectsbooleanstring

Defaulttrue

Whether redirects should be followed automatically.

logsarray

SubTypestring

Possible Values

REQUEST_HEADERSREQUEST_BODYRESPONSE_HEADERSRESPONSE_BODY

The enabled log.

proxy

The proxy configuration.

io.kestra.core.http.client.configurations.ProxyConfiguration

addressstring

The address of the proxy server.

passwordstring

The password for proxy authentication.

portintegerstring

The port of the proxy server.

typestring

DefaultDIRECT

Possible Values

DIRECTHTTPSOCKS

The type of proxy to use.

usernamestring

The username for proxy authentication.

ssl

The SSL request options

io.kestra.core.http.client.configurations.SslOptions

insecureTrustAllCertificatesbooleanstring

Whether to disable checking of the remote SSL certificate.

Only applies if no trust store is configured. Note: This makes the SSL connection insecure and should only be used for testing. If you are using a self-signed certificate, set up a trust store instead.

timeout

The timeout configuration.

io.kestra.core.http.client.configurations.TimeoutConfiguration

connectTimeoutstring

The time allowed to establish a connection to the server before failing.

readIdleTimeoutstring

DefaultPT5M

The time allowed for a read connection to remain idle before closing it.

stopAfter array

SubTypestring

Possible Values

CREATEDSUBMITTEDRUNNINGPAUSEDRESTARTEDKILLINGSUCCESSWARNINGFAILEDKILLEDCANCELLEDQUEUEDRETRYINGRETRIEDSKIPPEDBREAKPOINTRESUBMITTED

List of execution states after which a trigger should be stopped (a.k.a. disabled).

when string

Defaulttrue

A condition that determines whether the trigger should run.

A Pebble expression evaluated at trigger time. The trigger fires only when the expression evaluates to a truthy value (true, a non-empty string, a non-zero number). Use this to gate trigger execution on dynamic runtime values such as execution labels, flow variables, or environment conditions.

Outputs

checkedAt string

Formatdate-time

Timestamp of the monitor's most recent run, if reported by the API

monitorId string

Monitor ID that was polled

status string

Possible Values

PASSIN_TRAININGNOT_ENOUGH_DATAFAILED_TO_PREDICTINVALID_INPUTERRORFAILUNKNOWN

Monitor status when the trigger fired