Configuring retry mechanism for failed workflow actions

Enable automatic retries for failed workflow actions by setting retry intervals and maximum attempts.

Before you begin

You need execute permission for the project.

Procedure

  1. In a REST client platform, add authentication details of the tenant.
    
    //In case of Instance API key 
    Headers:
    {
    "x-instance-api-key": "instance_api_key"
    }
     
    // In case of MCSP or ISV token
    Headers:
    {
    "Authorization": "mcsp_or_isv_token"
    }
  2. Define retry settings in the body.
    {
    "retry_failed_action_execution": {
    "enable": true,
    "retry_interval": 3,
    "max_attempts": 1
    }
    }
    //enable is a required boolean field. Set it to true to enable retrying failed workflow actions, or false to disable the retry mechanism.
    //retry_interval is an optional numeric field that defines the time (in minutes) to wait between each retry attempt. If not specified, the default value is 3. The value must be within the range of 1 to 60 minutes, inclusive.
    //max_attempts is an optional numeric field that specifies the maximum number of retry attempts for a failed action. If not provided, the default value is 1. The value must not be negative, with no upper limit.
    //The value obtained by multiplying retry_interval and max_attempts must be less than 180. By default, this limit is 180.
    
  3. Make a PUT request at the URL of the workflow.
    URL Syntax - /apis/v2/rest/projects/:project/workflows/:workflow_uid/settings
    If the request is successful, you receive the response code for success.
    {
    "message": "workflow setting updated"
    }