Miro Boards Trigger
CertifiedTrigger a flow when new Miro boards are created
Miro Boards Trigger
Trigger a flow when new Miro boards are created
Polls the Miro boards list and fires an execution when new boards are created.
If neither teamId nor projectId is specified, the trigger defaults to watching the token's team (resolved via GET /v1/oauth-token).
The resolved token team is cached in the watermark KV key; after changing the token, delete that key to re-resolve it.
A watermark tracking the latest board creation timestamp and processed board IDs is persisted in the namespace KV store under key <flowId.length>_<flowId>_<triggerId.length>_<triggerId>_watermark, ensuring no boards are missed during downtime, restarts, or scheduler delays.
On the initial poll, boards created within the last configured interval are evaluated and the watermark is seeded.
Paging retrieves up to 10 pages per poll (offset pagination). If the 10-page cap is exceeded due to a large backlog, the poll fails to avoid data loss; to unblock and resume polling from the current time, delete the watermark key in the namespace KV store.
type: io.kestra.plugin.miro.boards.TriggerExamples
React when a new board is created in a team
id: on_new_miro_board
namespace: company.team
triggers:
- id: new_board
type: io.kestra.plugin.miro.boards.Trigger
token: "{{ secret('MIRO_TOKEN') }}"
teamId: "{{ secret('MIRO_TEAM_ID') }}"
interval: PT5M
tasks:
- id: handle_board
type: io.kestra.plugin.core.log.Log
message: "New board detected: {{ trigger.name }} (id: {{ trigger.id }})"
Installation
Our standard Docker images already include this plugin. If you use a -slim image or another setup, install it with the following command:
kestractl plugins get io.kestra.plugin:plugin-miro --compatible-for $KESTRA_VERSION For kestractl, use your Kestra version with --compatible-for, or specify an exact plugin version.
For Kestra CLI, replace LATEST with a specific version or version range to pin the plugin version.
Properties
token *string
Miro OAuth 2.0 access token
Use {{ secret('MIRO_TOKEN') }} to keep the token out of flow definitions.
allowConcurrent boolean
falseSpecifies whether a trigger is allowed to start a new execution even if a previous run is still in progress.
interval string
PT5MdurationPolling interval
How often to poll the Miro boards list.
limit integerstring
20Page size
Number of boards to fetch per page (1-50). Default is 20.
options
HTTP client configuration
io.kestra.core.http.client.configurations.HttpConfiguration
falseIf true, allow a failed response code (response code >= 400)
List of response code allowed for this request
The authentication to use.
io.kestra.core.http.client.configurations.BasicAuthConfiguration
The password for HTTP basic authentication.
The username for HTTP basic authentication.
io.kestra.core.http.client.configurations.BearerAuthConfiguration
The token for bearer token authentication.
io.kestra.core.http.client.configurations.DigestAuthConfiguration
The password for HTTP Digest authentication.
The username for HTTP Digest authentication.
UTF-8The default charset for the request.
java.nio.charset.Charset
trueWhether 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.
trueWhether redirects should be followed automatically.
REQUEST_HEADERSREQUEST_BODYRESPONSE_HEADERSRESPONSE_BODYThe enabled log.
The proxy configuration.
io.kestra.core.http.client.configurations.ProxyConfiguration
The address of the proxy server.
The password for proxy authentication.
The port of the proxy server.
DIRECTDIRECTHTTPSOCKSThe type of proxy to use.
The username for proxy authentication.
Retry strategy for HTTP requests.
retry is disabled by default.
Constant retry
Retry with a fixed delay between attempts.
durationRETRY_FAILED_TASKRETRY_FAILED_TASKCREATE_NEW_EXECUTION>= 1durationfalseExponential retry
Retry with exponentially increasing delays between attempts.
durationdurationRETRY_FAILED_TASKRETRY_FAILED_TASKCREATE_NEW_EXECUTION>= 1durationfalseRandom retry
Retry with a random delay within a configurable range between attempts.
durationdurationRETRY_FAILED_TASKRETRY_FAILED_TASKCREATE_NEW_EXECUTION>= 1durationfalse[502,503,504]HTTP status codes that should be retried.
Used for idempotent methods (GET, HEAD) without their own entry in retryOnStatusCodesByMethod. Non-idempotent methods are never retried on a status code unless listed in retryOnStatusCodesByMethod. Defaults to 502, 503 and 504 for idempotent methods (GET, HEAD) only.
Per-HTTP-method overrides for which status codes should be retried.
Keys are HTTP methods (e.g. GET, POST). A method with no entry here falls back to retryOnStatusCodes. This lets a caller retry more broadly for safe, read-only methods (for example, every 5xx and a 429 for GET/HEAD) while keeping a narrower list for methods that write, where retrying a request that may have already been processed by the origin risks duplicating the effect. Example: {GET: [429, 500, 502, 503, 504], HEAD: [429, 500, 502, 503, 504]}.
["GET","HEAD"]HTTP methods for which any transport-level failure may be retried.
A transport-level failure is a connection or timeout error rather than an HTTP response (e.g. a read timeout or a connection reset mid-request). For a method listed here, any such failure is retried. Defaults to GET and HEAD HTTP methods.
The SSL request options
io.kestra.core.http.client.configurations.SslOptions
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.
The timeout configuration.
io.kestra.core.http.client.configurations.TimeoutConfiguration
The time allowed to establish a connection to the server before failing.
PT5MThe time allowed for a read connection to remain idle before closing it.
projectId string
Project ID
Restrict the watch to boards in this project. If neither teamId nor projectId is specified, defaults to the authenticated token's team.
stopAfter array
CREATEDSUBMITTEDRUNNINGPAUSEDRESTARTEDKILLINGSUCCESSWARNINGFAILEDKILLEDCANCELLEDQUEUEDRETRYINGRETRIEDSKIPPEDBREAKPOINTRESUBMITTEDList of execution states after which a trigger should be stopped (a.k.a. disabled).
teamId string
Team ID
Restrict the watch to boards in this team. If neither teamId nor projectId is specified, defaults to the authenticated token's team.
when string
trueA 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
boards array
New boards
All new boards detected in this evaluation cycle.
count integer
Count
Number of new boards detected.
createdAt string
Created at
ISO-8601 creation timestamp of the first new board.
id string
Board ID
ID of the first new board detected.
name string
Board name
Name of the first new board detected.
