Skip to main content

WorkflowRetryPolicyUpdateSchema

Schema for updating retry policies for a workflow.

workflow_idWorkflow Id (string)required
default_retry_policy object

Default retry policy for all steps

anyOf
string
step_overrides object

Per-step retry configuration overrides

anyOf
  • Array [
  • step_indexStep Index (integer)required

    Possible values: >= 0

    step_name object
    anyOf
    string
    action_typeAction Type (string)required
    retry_config objectrequired

    Complete retry configuration for an action.

    retry_policy object
    anyOf
    enabledEnabled (boolean)
    Default value: true
    max_attemptsMax Attempts (integer)

    Possible values: >= 1 and <= 10

    Default value: 3
    strategyRetryStrategyEnum (string)

    Possible values: [exponential_backoff, linear_backoff, fixed_delay]

    Default value: exponential_backoff
    base_delay_msBase Delay Ms (integer)

    Possible values: >= 100 and <= 60000

    Default value: 1000
    max_delay_msMax Delay Ms (integer)

    Possible values: >= 1000 and <= 300000

    Default value: 30000
    jitterJitter (boolean)
    Default value: true
    circuit_breaker object
    anyOf
    enabledEnabled (boolean)
    Default value: true
    failure_thresholdFailure Threshold (integer)

    Possible values: >= 1 and <= 100

    Default value: 5
    recovery_timeout_msRecovery Timeout Ms (integer)

    Possible values: >= 1000 and <= 300000

    Default value: 60000
    success_thresholdSuccess Threshold (integer)

    Possible values: >= 1 and <= 10

    Default value: 2
    retry_policy_name object

    Name of a pre-configured retry policy (default, aggressive, gentle, webhook, email, sms)

    anyOf
    string
  • ]
  • WorkflowRetryPolicyUpdateSchema
    {
    "workflow_id": "string",
    "default_retry_policy": "string",
    "step_overrides": [
    {
    "step_index": 0,
    "step_name": "string",
    "action_type": "string",
    "retry_config": {
    "retry_policy": {
    "enabled": true,
    "max_attempts": 3,
    "strategy": "exponential_backoff",
    "base_delay_ms": 1000,
    "max_delay_ms": 30000,
    "jitter": true
    },
    "circuit_breaker": {
    "enabled": true,
    "failure_threshold": 5,
    "recovery_timeout_ms": 60000,
    "success_threshold": 2
    },
    "retry_policy_name": "string"
    }
    }
    ]
    }