View as Markdown

UpdateWorkflowRequest

Field	Type	Description
workflow_id	string	The ID of the workflow to update.
workflow	bitdrift.public.unary.explorations.v1.Workflow	The updated workflow. This should be the entire workflow with all changes applied, not just the delta. The server will apply the changes and return the fully updated workflow in the response.
metadata	bitdrift.public.unary.explorations.v1.WorkflowMetadata	Optional updated metadata to attach to the workflow. Metadata can always be changed while the workflow is deployed.
per_rule_chart_metadata	repeated bitdrift.public.unary.explorations.v1.PerRuleChartMetadata	Optional chart metadata to attach. This is useful inline with workflow updates to provide defaults for rules with charts attached.

Example

JSON

{
  "metadata": {
    "deployment_expiration": {
      "fixed_time": {
        "time": "3600s"
      }
    },
    "per_rule_metadata": [
      {
        "rule_id": "actn_ghi789",
        "title": "My Workflow"
      }
    ]
  },
  "per_rule_chart_metadata": [
    {
      "metadata": {
        "metric_chart_metadata": {
          "metadata": [
            {
              "connector_export_config": [
                {
                  "cloudwatch_connector_export_config": {
                    "fixed_dimensions": {
                      "key": ""
                    },
                    "namespace": "payments"
                  },
                  "connector_name": "primary-cloudwatch"
                }
              ],
              "limit_strategy": {},
              "sort_order": "DESC",
              "title": "My Workflow",
              "top_k_algorithm": "MAX",
              "y_axis": {
                "description": "Example text",
                "unit": "COUNT"
              }
            }
          ],
          "time_series_display_mode": {}
        },
        "no_data_message": "Example text",
        "summary": {
          "description": "Example text"
        },
        "title": "My Workflow"
      },
      "rule_id": "actn_ghi789"
    }
  ],
  "workflow": {
    "actions": [
      {
        "metric_chart_rule": {
          "time_series": [
            {
              "aggregated_id": "abc-123-def",
              "rate": {
                "denominator": {
                  "match_id": "match-abc",
                  "name": "My Workflow"
                },
                "denominator_id": "abc-123-def",
                "group_by": {
                  "values": [
                    {
                      "log_body": false
                    }
                  ]
                },
                "numerator": {
                  "match_id": "match-abc",
                  "name": "My Workflow"
                },
                "numerator_id": "abc-123-def"
              },
              "track_unique": {
                "device_id": true
              }
            }
          ]
        },
        "rule_id": "actn_ghi789"
      }
    ],
    "created_at": "2024-01-15T09:30:00Z",
    "deployed_at": "2024-01-15T09:30:00Z",
    "deployment_expiration_time": "2024-01-15T09:30:00Z",
    "flows": [
      {
        "exclusive": {},
        "steps": [
          {
            "exit_conditions": [
              {
                "match_rule": {
                  "generic_match": {
                    "base_matcher": {
                      "log_field": "field_name",
                      "operator": "EQUAL",
                      "string_value": "example"
                    }
                  },
                  "match_id": "match-abc",
                  "sample_rate": 100
                }
              }
            ],
            "loop_match_id": "match-abc",
            "match_rule": {
              "generic_match": {
                "base_matcher": {
                  "log_field": "field_name",
                  "operator": "EQUAL",
                  "string_value": "example"
                }
              },
              "match_id": "match-abc",
              "sample_rate": 100
            },
            "save_fields": [
              {}
            ]
          }
        ]
      }
    ],
    "group_by_fields": [
      "field_name"
    ],
    "id": "wrkf_abc123",
    "name": "My Workflow",
    "owner": {
      "email": "user@example.com",
      "id": "usr_abc123",
      "name": "Jane Doe"
    },
    "platform_targets": [
      {
        "apple": {
          "apps": [
            {
              "app_id": "com.example.app"
            }
          ]
        }
      }
    ],
    "state": "LIVE",
    "updated_at": "2024-01-15T09:30:00Z"
  },
  "workflow_id": "wrkf_abc123"
}