Sifflet RunRule

Sifflet RunRule

Certified

Trigger a Sifflet data quality rule

Call Sifflet's /api/v1/rules/{ruleId}/_run endpoint to launch a rule run. Inputs are rendered with the Run Context; defaults include https://api.siffletdata.com and a 30s timeout.

yaml
type: io.kestra.plugin.sifflet.RunRule

Run a Sifflet rule

yaml
id: sifflet_flow
namespace: company.team
tasks:
  - id: run_rule
    type: io.kestra.plugin.sifflet.RunRule
    apiKey: "{{ secret('SIFFLET_API_KEY') }}"
    ruleId: "rule-123"
    baseUrl: "https://api.siffletdata.com"

Run with default base URL and custom timeout

yaml
id: sifflet_flow
namespace: company.team
tasks:
  - id: run_rule_timeout
    type: io.kestra.plugin.sifflet.RunRule
    apiKey: "{{ secret('SIFFLET_API_KEY') }}"
    ruleId: "rule-456"
    requestTimeout: 60
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-sifflet --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

Sifflet API key

Bearer token for the Sifflet API; renderable and should be stored as a secret

Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.

Definitions
assetFailureBehaviorstring
Possible Values
IGNOREFAILWARN

Asset failure behavior

Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.

enableAutobooleanstring

Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.

inputsarray

The assets consumed as inputs.

id*string
Min length1
typestring
outputs

The assets produced as outputs.

id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*string
Min length1

Custom asset type

descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150

Sifflet API base URL

Base URL for the Sifflet API; defaults to https://api.siffletdata.com when omitted

Default30

Request timeout

Timeout in seconds for both connection and request; defaults to 30

Rule ID

Identifier of the Sifflet rule to execute; required for a valid call and rendered before the request

Raw response from the Sifflet API

The ID of the executed rule

Status of the rule execution (SUCCESS or FAILED)

HTTP status code from the API response

More Plugins in this Category

Firecrawl
Firecrawl

Tasks that scrape and crawl websites into clean, LLM-ready content with Firecrawl.

Data

2 tasks

Liquibase
Liquibase

Tasks that run Liquibase change management commands.

Data

2 tasks

8 blueprints