---
title: "Update deployment event"
method: PATCH
path: "/events/deployment/{id}"
tags: ["Event"]
---

# Update deployment event

`PATCH /events/deployment/{id}`

Update selective attributes on existing deployment event (backend only)

## Path parameters

- `id` string, required

## Headers

- `If-Match` string

## Request body

- DeploymentEventUpdateRequest — Updatable deployment event attributes
  - `source_control` SourceControl
    - `revision` string — the primary source revision associated with this object
    - `revisions` string[] — all source revision ids associated with this object
    - `commit_username` string — the username of the user who committed the revision associated with this object
    - `branch_name` string — the branch associated with this object
    - `branches` SourceControlBranch[] — Related branches
      - `name` string, required — repository unique branch name
      - `html_url` string, required — HTML page url to view branch tree
    - `pull_request` SourceControlPullRequest — the pull request associated with this object
      - `id` string — vendor unique pull request identifier (immutable)
      - `number` integer — the number associated with the pull request (repository unique)
      - `title` string — the title of the pull request
      - `html_url` string — HTML page url to view pull request object
    - `pull_requests` SourceControlPullRequest[] — Related pull requests
      - `id` string — vendor unique pull request identifier (immutable)
      - `number` integer — the number associated with the pull request (repository unique)
      - `title` string — the title of the pull request
      - `html_url` string — HTML page url to view pull request object
    - `authors` SourceControlAuthor[] — Related authors. Should be at least one
      - `id` string, required — vendor unique author id (invariant)
      - `user_name` string, required — author username name (mutable)
      - `name` string — author full name (mutable)
      - `email` string — author email
      - `html_url` string, required — HTML page url to view author
      - `avatar_url` string, required — author avatar image URL
      - `user_type` string — repository name unique within owner scope
    - `repository_url` string — the url of the repository associated with this object
    - `repository_name` string — the name of the repository associated with this object
    - `repository` SourceControlRepository — the SCM repository associated with this object
      - `id` string, required — vendor unique repository id (immutable)
      - `name` string, required — repository name unique within owner scope
      - `full_name` string — vendor unique name to identify this repo across all vendor's repos
      - `owner_name` string, required — repository name unique within owner scope
      - `owner` SourceControlRepositoryOwner — the SCM repository associated with this object
        - `id` string, required — vendor unique repository id (immutable)
        - `name` string, required — repository name unique within owner scope
        - `owner_type` string, required — repository name unique within owner scope
        - `html_url` string, required — HTML page url to view branch tree
        - `avatar_url` string — owner avatar image URL
      - `html_url` string, required — HTML page url to view branch tree
      - `is_public` boolean — true if repository publicly visible
      - `checkout_url` string — SCM remote checkout path

## Response `200`

Updated entity

- DeploymentEventResult — Describes a deployment event and the result of any triggered plan runs
  - `id` string, required — Unique ID for the deployment event
  - `environment_id` string — ID of the environment associated with this deployment
  - `application_id` string — ID of the application associated with this deployment
  - `workspace_id` string, required — ID of the workspace associated with this deployment
  - `event_time` integer — Epoch millisecond timestamp at which the deployment occurred
  - `received_time` integer — Epoch millisecond timestamp the event was received at
  - `revision` string — Source code revision
  - `properties` object — Arbitrary key-value pairs used to pass additional information about this deployment
  - `triggered_plan_run_summaries` DeploymentPlanSummary[] — Summary of the plans that were triggered by this deployment event
    - `plan_id` string — Unique ID for this plan
    - `plan_run_id` string — The ID of run of the plan
  - `plan_overrides` object — Optional overrides specified for the stored properties of any triggered plans
  - `plan_labels` string[] — If specified, only plans matching the given labels were executed
  - `actions` object — Optional actions specified for mabl to take on this deployment
  - `run_result` ExecutionResult — Summary of plan/test execution results
    - `event_status` EventStatus
      - `succeeded` boolean — True if succeeded_first_attempt is true or succeeded_with_retries is true
      - `succeeded_first_attempt` boolean — True if all associated plan runs passed on the first attempt
      - `succeeded_with_retries` boolean — True if all associated plan runs passed taking retries into account
      - `succeeded_by_plan` object — Map of plan ID to boolean indicating whether the plan passed
    - `plan_execution_metrics` ExecutionMetrics
      - `total` integer — The total number of executions
      - `passed` integer — The number of executions that passed
      - `failed` integer — The number of executions that failed
      - `running` integer — The number of executions that are still running
      - `skipped` integer — The number of executions that were skipped
      - `terminated` integer — The total number of executions that were terminated before completion
    - `journey_execution_metrics` ExecutionMetrics
      - `total` integer — The total number of executions
      - `passed` integer — The number of executions that passed
      - `failed` integer — The number of executions that failed
      - `running` integer — The number of executions that are still running
      - `skipped` integer — The number of executions that were skipped
      - `terminated` integer — The total number of executions that were terminated before completion
    - `failure_analysis` FailureRootCauseAnalysis
      - `headline` string — The short summary of the run analysis; typically limited to one sentence
      - `summary` string — The summary of the analysis for the run failure
      - `failure_category_id` string — The suggested failure category if applicable
      - `evidence_details` string — Agent-generated detailed evidence supporting the analysis, if available
    - `executions` ExecutionSummary[] — Complete list of all plan runs
      - `status` 'queued' | 'pre_execution' | 'scheduling' | 'scheduled' | 'succeeded' | 'failed' | 'cancelled' | 'post_execution' | 'completed' | 'terminated' — Current status of the plan run
      - `status_cause` string — Cause for setting given status, such as failure cause
      - `success` boolean — true if the plan completed successfully
      - `plan` PlanSummary
        - `id` string, required — plan id
        - `name` string — plan name
        - `href` string, required — URL for retrieving the plan
        - `app_href` string, required — URL for viewing the plan in the mabl app
        - `tags` Tag[] — tags associated with the plan
          - `name` string, required — tag name
          - `values` string[]
      - `plan_execution` PlanExecutionResult — Provides information about the result of a plan execution
        - `id` string, required — The plan run ID
        - `status` 'queued' | 'pre_execution' | 'scheduling' | 'scheduled' | 'succeeded' | 'failed' | 'cancelled' | 'post_execution' | 'completed' | 'terminated' — Current status of the plan run
        - `status_cause` string — Cause for setting given status, such as failure cause
        - `href` string, required — URL for retrieving the plan run
        - `is_retry` boolean — true if this plan run is a retry of a previously failed execution
        - `retry_of_id` string — if is_retry is true, this is the ID of the plan run that this retry is associated with
      - `journeys` TestSummary[] — The tests in this plan
        - `id` string, required — Test id
        - `name` string — test name
        - `href` string, required — URL for retrieving the test
        - `app_href` string, required — URL for viewing the test in the mabl app
        - `tags` Tag[] — tags associated with this test
          - `name` string, required — tag name
          - `values` string[]
      - `journey_executions` TestRunResult[] — The test runs in this plan
        - `id` string — Test run id
        - `test_ref_id` string — reference to this test in another system
        - `workspace_id` string — workspace Id
        - `started_time` integer — Time test run was started, in epoch milliseconds
        - `completed_time` integer — Time test run was completed, in epoch milliseconds
        - `tags` Tag[] — Free text tags associated with this entity
          - `name` string, required — tag name
          - `values` string[]
        - `journey_id` string, required — (deprecated, use test_id) Test id
        - `test_id` string — Test id
        - `test_labels` string[] — Test labels
        - `test_name` string — Test name
        - `test_type` 'api' | 'browser' | 'performance' | 'mobile' — Type of test
        - `failure_summary` TestRunFailureSummary — Information useful for diagnosing test run failures
          - `flow_id` string — ID of the flow in which the failure occurred
          - `flow_name` string — Name of the flow in which the failure occurred, if any
          - `step_number` integer — Step number within the flow where the failure occurred
          - `step_id` string — ID of the step (with respect to the flow) where the failure occurred
          - `step_id_in_test` string — ID of the step (with respect to the test) where the failure occurred
          - `step_display_number` string — Display number of the failing step in nested dotted notation (e.g. "2.7" or "2.7.3"). Null when unavailable; only populated for runs executed after this field shipped (not present on backfilled historical runs).
          - `error` string — Unexpected error or formatted assertion failure that was recorded
          - `image_uri` string — URL of an image showing the error
          - `image_href` string — URL of an image showing the error
          - `image_artifact_url` string — API url of the image that will redirect to a newly signed image url
          - `assert_failure` AssertFailure — Details about assert failure
            - `reason` string — Assert failure description without expected/found values to eliminate the need for parsing downstream
            - `expected` string — Expected value where applicable
            - `found` string — Value actually found during test execution
        - `failure_categorization` FailureCategorization — Information describing the cause of a test run failure
          - `failure_category_id` string — A failure category id
          - `failure_synopsis` string — DEPRECATED -- Now persisted as FailureAnalysis -- A synopsis of the failure summary
          - `failure_summary_text` string — A summary describing the test run failure and potential root cause
          - `is_failure_category_generated` boolean — Indicates if the failure category was generated by AI
          - `is_failure_summary_generated` boolean — Indicates if the failure summary was generated by AI
          - `suggested_failure_category_id` string — Failure category ID suggested by automated analysis
          - `last_updated_by_id` string — The ID of the user who updated the categorization of this failure
          - `last_updated_time` integer — time the failure categorization was last updated
          - `failure_reason_assignment_source` 'manual' | 'auto' — How the failure reason was assigned to this test run. Server-managed; client-supplied values are ignored on write.
          - `failure_reason_assigned_by_id` string — The ID of the user or system that assigned the failure reason. Server-managed; client-supplied values are ignored on write.
          - `failure_reason_assigned_time` integer — Timestamp in epoch milliseconds when the failure reason was assigned. Server-managed; client-supplied values are ignored on write.
        - `test_cases` ExternalTestCase[] — User provided external test cases
          - `id` string — Id associated with this test case
        - `timing_summary` TimingSummary — Sumamry of various timing measures for this run
          - `find_time_ms` integer — Total time spent in finds for this run
          - `find_extra_wait_time_ms` integer — Extra wait time added by intelligent waiting in finds
        - `execution_source` 'mabl_cloud' | 'external' | 'mabl_local' | 'mabl_agent' — Where the test lives
        - `status` 'awaiting_precondition' | 'skipped' | 'rate_limited' | 'queued' | 'running' | 'completed' | 'failed' | 'terminating' | 'terminated' — The current status of this test run
        - `status_cause` string — Cause for setting given status, such as failure cause. Updated in pairs with Status.
        - `outcome` 'passed' | 'failed' | 'stopped'
        - `customer_log_uri` string — Customer facing output log (formerly output_log_uri)
        - `journey_execution_id` string, required — (deprecated, use id instead) The test run ID
        - `application_id` string — the id of the application associated with this run
        - `environment_id` string — the id of the environment associated with this run
        - `initial_url` string — the URL where the test started
        - `run_multiplier_index` integer — Zero-indexed run multiplier index for this run
        - `browser_type` string — the type of browser associated with this run
        - `scenario_name` string — the scenario name associated with this run, if any
        - `success` boolean — true if the test run completed successfully
        - `href` string, required — URL for retrieving the test run
        - `app_href` string, required — URL for viewing the test run results in the mabl app
        - `start_time` integer — (deprecated, use started_time) The time this test run started
        - `stop_time` integer — (deprecated, use completed_time) The time this test run stopped
        - `termination_reason` string — Termination reason when status is terminated (mirrors TestRun.termination_reason values, e.g. usage_quota_exceeded)
      - `start_time` integer — Plan run start time
      - `stop_time` integer — Plan run end time
  - `source_control` SourceControl
    - `revision` string — the primary source revision associated with this object
    - `revisions` string[] — all source revision ids associated with this object
    - `commit_username` string — the username of the user who committed the revision associated with this object
    - `branch_name` string — the branch associated with this object
    - `branches` SourceControlBranch[] — Related branches
      - `name` string, required — repository unique branch name
      - `html_url` string, required — HTML page url to view branch tree
    - `pull_request` SourceControlPullRequest — the pull request associated with this object
      - `id` string — vendor unique pull request identifier (immutable)
      - `number` integer — the number associated with the pull request (repository unique)
      - `title` string — the title of the pull request
      - `html_url` string — HTML page url to view pull request object
    - `pull_requests` SourceControlPullRequest[] — Related pull requests
      - `id` string — vendor unique pull request identifier (immutable)
      - `number` integer — the number associated with the pull request (repository unique)
      - `title` string — the title of the pull request
      - `html_url` string — HTML page url to view pull request object
    - `authors` SourceControlAuthor[] — Related authors. Should be at least one
      - `id` string, required — vendor unique author id (invariant)
      - `user_name` string, required — author username name (mutable)
      - `name` string — author full name (mutable)
      - `email` string — author email
      - `html_url` string, required — HTML page url to view author
      - `avatar_url` string, required — author avatar image URL
      - `user_type` string — repository name unique within owner scope
    - `repository_url` string — the url of the repository associated with this object
    - `repository_name` string — the name of the repository associated with this object
    - `repository` SourceControlRepository — the SCM repository associated with this object
      - `id` string, required — vendor unique repository id (immutable)
      - `name` string, required — repository name unique within owner scope
      - `full_name` string — vendor unique name to identify this repo across all vendor's repos
      - `owner_name` string, required — repository name unique within owner scope
      - `owner` SourceControlRepositoryOwner — the SCM repository associated with this object
        - `id` string, required — vendor unique repository id (immutable)
        - `name` string, required — repository name unique within owner scope
        - `owner_type` string, required — repository name unique within owner scope
        - `html_url` string, required — HTML page url to view branch tree
        - `avatar_url` string — owner avatar image URL
      - `html_url` string, required — HTML page url to view branch tree
      - `is_public` boolean — true if repository publicly visible
      - `checkout_url` string — SCM remote checkout path

## Other responses

- `401` — Missing or invalid API token
- `403` — Given token is not authorized
- `404` — Event not found
- `default` — Unknown error

---

[API](https://skmtc.net/mabl/apis/mabl-api.md) · [All operations](https://skmtc.net/mabl/apis/mabl-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/mabl/mabl-api/revisions/d0fc0114da66/schema)